python/module-private-name
| Rule | module-private-name |
|---|---|
| Pack | Python |
| Severity | warning |
| Fix | none, edit by hand |
| Library versions | every version |
A module level name that starts with an underscore hides code that other modules may need. Give it a public name, and list what callers may import in __all__.
_LIMIT = 100__all__ = ["total"]
LIMIT = 100
def _prices(rows): return [row["price"] for row in rows][:_LIMIT]def prices(rows): return [row["price"] for row in rows][:LIMIT]
def total(rows): return sum(_prices(rows)) return sum(prices(rows))What the rule reports
Section titled “What the rule reports”The rule reports a function, class or variable at module level whose name starts with an underscore.
The rule leaves alone the cases in the list:
How to fix it
Section titled “How to fix it”xpd has no automatic fix, so make the change by hand.
__all__ says in one place which names callers may import, and from module import *, type
checkers and documentation tools all read it. An underscore says the same thing once per name
and makes every use of the name harder to read.
- A method or attribute of a class, such as
def _load(self), and a name inside a function. _alone, and names with two leading underscores such as__all__and__version__._T = TypeVar("_T"), and the same forParamSpecandTypeVarTuple. A type variable is never part of a module's API, and typeshed, the type stubs of the standard library, and the typing documentation write it with an underscore. On Python 3.12,def first[T](xs: list[T]) -> Tneeds no module level name.- A file that imports
hamilton, where an underscore tells Hamilton that a function is not a node.
Message
Section titled “Message”xpd prints this message with the issue. A name that starts with $ stands for code from your file.
$NAME is a module level name that starts with an underscore. Give it a public name, and list the names callers may import in __all__.Browse the other rules of the Python pack.