Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve implicit-namespace-package documentation

This commit is contained in:
Charlie Marsh 2023-02-10 18:06:48 -05:00
parent 113610a8d4
commit c8f60c9588
2 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
crates/ruff/src/rules/flake8_no_pep420/rules.rs
View File

@ -18,13 +18,16 @@ define_violation!(
/// imported. /// imported.
/// ///
/// Directories that lack an `__init__.py` file can still be imported, but /// Directories that lack an `__init__.py` file can still be imported, but
/// they're indicative of a special kind of package, known as a namespace /// they're indicative of a special kind of package, known as a "namespace
/// package (see: [PEP 420](https://www.python.org/dev/peps/pep-0420/)). /// package" (see: [PEP 420](https://www.python.org/dev/peps/pep-0420/)).
/// Namespace packages are less widely used, so a package that lacks an
/// `__init__.py` file is typically meant to be a regular package, and
/// the absence of the `__init__.py` file is probably an oversight.
/// ///
/// Namespace packages are a relatively new feature of Python, and they're /// Note that namespace packages can be specified via the
/// not widely used. So a package that lacks an `__init__.py` file is /// [`namespace-packages`](https://github.com/charliermarsh/ruff#namespace-packages)
/// typically meant to be a regular package, and the absence of the /// configuration option. Adding a namespace package to the configuration
/// `__init__.py` file is probably an oversight. /// will suppress this violation for a given package.
pub struct ImplicitNamespacePackage(pub String); pub struct ImplicitNamespacePackage(pub String);
); );
impl Violation for ImplicitNamespacePackage { impl Violation for ImplicitNamespacePackage {

15
docs/rules/implicit-namespace-package.md
View File

@ -12,10 +12,13 @@ package, and so it can be imported the same way a module can be
imported. imported.
Directories that lack an `__init__.py` file can still be imported, but Directories that lack an `__init__.py` file can still be imported, but
they're indicative of a special kind of package, known as a namespace they're indicative of a special kind of package, known as a "namespace
package (see: [PEP 420](https://www.python.org/dev/peps/pep-0420/)). package" (see: [PEP 420](https://www.python.org/dev/peps/pep-0420/)).
Namespace packages are less widely used, so a package that lacks an
`__init__.py` file is typically meant to be a regular package, and
the absence of the `__init__.py` file is probably an oversight.
Namespace packages are a relatively new feature of Python, and they're Note that namespace packages can be specified via the
not widely used. So a package that lacks an `__init__.py` file is [`namespace-packages`](https://github.com/charliermarsh/ruff#namespace-packages)
typically meant to be a regular package, and the absence of the configuration option. Adding a namespace package to the configuration
`__init__.py` file is probably an oversight. will suppress this violation for a given package.