How do I identify which private functions need to be exported?

The skill suggests searching your codebase for usage patterns like 'from [module] import _' and running test suites to catch 'cannot import name' errors triggered by the reorganization.

Why does 'import *' fail for private functions in Python?

By default, Python's wildcard import mechanism ignores any name starting with an underscore to protect the internal API, unless those names are explicitly listed in the module's __all__ variable.

When should I use this specific shim pattern?

Use this pattern during module reorganization when you move a file but leave a 'shim' file at the old location to prevent breaking changes for other modules that rely on its private functions.

Will this help with public API compatibility as well?

Yes, while it specifically addresses the 'private function' edge case, it works alongside standard shim patterns to ensure both public and private APIs remain accessible after a move.

Private Function Shim Export

Name: Private Function Shim Export
Author: smith6jt-cop

bysmith6jt-cop

开发者工具

Ensures Python compatibility shims correctly export private functions during module reorganizations.

关于

This skill addresses a common pitfall in Python package refactoring where wildcard imports fail to export internal functions. When moving modules to new locations, standard compatibility shims often break because Python's 'import *' mechanism excludes names starting with an underscore. This skill provides a systematic approach to identifying these missing dependencies and generating explicit exports, allowing developers to reorganize codebases without breaking internal functionality or existing import paths.

主要功能

Verifies shim integrity using direct Python import testing
Provides diagnostic grep commands to trace internal function usage
Prevents 'ImportError: cannot import name' during module migrations
Identifies underscore-prefixed functions missing from wildcard imports
Automates the creation of explicit export patterns for compatibility shims
0 GitHub stars

使用场景

Consolidating multiple utility files into a single package structure
Moving legacy Python modules to subpackages while maintaining backwards compatibility
Archiving deprecated code into subdirectories without breaking internal dependencies

关于

主要功能

Verifies shim integrity using direct Python import testing
Provides diagnostic grep commands to trace internal function usage
Prevents 'ImportError: cannot import name' during module migrations
Identifies underscore-prefixed functions missing from wildcard imports
Automates the creation of explicit export patterns for compatibility shims
0 GitHub stars

使用场景

Consolidating multiple utility files into a single package structure
Moving legacy Python modules to subpackages while maintaining backwards compatibility
Archiving deprecated code into subdirectories without breaking internal dependencies