generated from jCloud/repository-template
chore: update API reference
This commit is contained in:
1 parent
1ccb610310
commit
4b659d7d2d
1 file changed
+44
@@ -1,5 +1,45 @@
|
|||||||
# Module `jcloud_docsgen.core.python.namespaces`
|
# Module `jcloud_docsgen.core.python.namespaces`
|
||||||
|
|
||||||
|
## Function `validate_namespace_name`
|
||||||
|
|
||||||
|
Checks whether a namespace name is valid. Namespace names are valid
|
||||||
|
if they contain no dots and are valid Python identifiers.
|
||||||
|
|
||||||
|
### Function signature
|
||||||
|
|
||||||
|
```python
|
||||||
|
validate_namespace_name(name: str) -> bool
|
||||||
|
```
|
||||||
|
|
||||||
|
### Returns
|
||||||
|
|
||||||
|
Whether the namespace name is valid.
|
||||||
|
|
||||||
|
Return type: `bool`
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Kind | Default value | Description |
|
||||||
|
| --- | --- | --- | --- | --- |
|
||||||
|
| `name` | `str` | normal | -- | The namespace name to validate. |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Docstring
|
||||||
|
|
||||||
|
Checks whether a namespace name is valid. Namespace names are valid
|
||||||
|
if they contain no dots and are valid Python identifiers.
|
||||||
|
|
||||||
|
:param name: The namespace name to validate.
|
||||||
|
:type name: str
|
||||||
|
|
||||||
|
:returns: Whether the namespace name is valid.
|
||||||
|
:rtype: bool
|
||||||
|
|
||||||
## Class `PythonNamespace`
|
## Class `PythonNamespace`
|
||||||
|
|
||||||
The base class for all Python namespaces such as modules or packages.
|
The base class for all Python namespaces such as modules or packages.
|
||||||
@@ -57,6 +97,8 @@ The base class for all Python namespaces such as modules or packages.
|
|||||||
:param name: The name of the namespace.
|
:param name: The name of the namespace.
|
||||||
:type name: str
|
:type name: str
|
||||||
|
|
||||||
|
:raises InvalidNamespaceError: If the namespace name is invalid.
|
||||||
|
|
||||||
## Class `PythonPackageNamespace`
|
## Class `PythonPackageNamespace`
|
||||||
|
|
||||||
A subclass of ``PythonNamespace`` for Python package namespaces.
|
A subclass of ``PythonNamespace`` for Python package namespaces.
|
||||||
@@ -381,6 +423,8 @@ A subclass of ``PythonNamespace`` for Python package namespaces.
|
|||||||
:param sub_namespaces: The sub-namespaces.
|
:param sub_namespaces: The sub-namespaces.
|
||||||
:type sub_namespaces: list[PythonNamespace]
|
:type sub_namespaces: list[PythonNamespace]
|
||||||
|
|
||||||
|
:raises InvalidNamespaceError: If the namespace name is invalid.
|
||||||
|
|
||||||
## Class `PythonModuleNamespace`
|
## Class `PythonModuleNamespace`
|
||||||
|
|
||||||
A subclass of ``PythonNamespace`` for Python module namespaces.
|
A subclass of ``PythonNamespace`` for Python module namespaces.
|
||||||
|
|||||||
Reference in new issue
Block a user