+ Otto the Otter +
+
+ Otto the Otter
+
+ 
+ 
attrbox.attrdictattrbox.attrdictattrbox.attrdictattrbox.attrdictattrbox.attrdictattrbox.attrdict
-def __contains__(self, name: Any) ‑> bool
+def __contains__(self, key: Any) ‑> bool
Return True if name is a key.
Return True if key is a key.
name : Anykey : AnyAnyIndex. If it's a string,
the check proceeds as usual. If it's a Sequence, the
checks are performed using .get().boolTrue if the name is a valid key, False otherwise.True if the key is a valid key, False otherwise.Normal checking works as expected:
@@ -793,16 +793,16 @@def __contains__(self, name: Any) -> bool:
- """Return `True` if `name` is a key.
+def __contains__(self, key: Any) -> bool:
+ """Return `True` if `key` is a key.
Args:
- name (Any): typically a `AnyIndex`. If it's a string,
+ key (Any): typically a `AnyIndex`. If it's a string,
the check proceeds as usual. If it's a `Sequence`, the
checks are performed using `.get()`.
Returns:
- bool: `True` if the `name` is a valid key, `False` otherwise.
+ bool: `True` if the `key` is a valid key, `False` otherwise.
Examples:
Normal checking works as expected:
@@ -819,7 +819,7 @@ Examples
>>> ['a', 1, 'x'] in items
False
"""
- return self.get(name, NOT_FOUND) is not NOT_FOUND
+ return self.get(key, NOT_FOUND) is not NOT_FOUND
@@ -1034,13 +1034,13 @@ Examples
-def __getitem__(self, name: AnyIndex) ‑> Optional[Any]
+def __getitem__(self, key: AnyIndex) ‑> Optional[Any]
-
Return the value of the key.
Args
-name : AnyIndexkey : AnyIndex- key name or Sequence of the path to a key
Returns
@@ -1059,11 +1059,11 @@ Examples
Expand source code
-def __getitem__(self, name: AnyIndex) -> Optional[Any]:
+def __getitem__(self, key: AnyIndex) -> Optional[Any]:
"""Return the value of the key.
Args:
- name (AnyIndex): key name or Sequence of the path to a key
+ key (AnyIndex): key name or Sequence of the path to a key
Returns:
Any: value of the key or `None` if it cannot be found
@@ -1075,17 +1075,17 @@ Examples
>>> item['b'] is None
True
"""
- return self.get(name)
+ return self.get(key)
-def __setitem__(self, name: AnyIndex, value: Any) ‑> None
+def __setitem__(self, key: AnyIndex, value: Any) ‑> None
-
Set the value of a key.
Args
-name : BoxIndexkey : AnyIndex- key name
value : Any- key value
@@ -1104,11 +1104,11 @@ Examples
Expand source code
-def __setitem__(self, name: AnyIndex, value: Any) -> None:
+def __setitem__(self, key: AnyIndex, value: Any) -> None:
"""Set the value of a key.
Args:
- name (BoxIndex): key name
+ key (AnyIndex): key name
value (Any): key value
Examples:
@@ -1121,17 +1121,17 @@ Examples
>>> item.a.b
10
"""
- self.set(name, value)
+ self.set(key, value)
-def __delitem__(self, name: str) ‑> None
+def __delitem__(self, key: str) ‑> None
-
Delete a key.
Args
-name : strkey : str- key name
Examples
@@ -1150,11 +1150,11 @@ Examples
Expand source code
-def __delitem__(self, name: str) -> None:
+def __delitem__(self, key: str) -> None:
"""Delete a key.
Args:
- name (str): key name
+ key (str): key name
Examples:
>>> item = AttrDict(a=1)
@@ -1169,7 +1169,7 @@ Examples
{'a': 1}
"""
try:
- super().__delitem__(name)
+ super().__delitem__(key)
except KeyError:
pass
diff --git a/docs/config.html b/docs/config.html
index 2a41d43..5dacc4b 100644
--- a/docs/config.html
+++ b/docs/config.html
@@ -36,6 +36,7 @@ Module attrbox.config
from typing import Callable
from typing import Dict
from typing import List
+from typing import LiteralString
from typing import Mapping
from typing import Optional
from typing import Sequence
@@ -51,7 +52,7 @@ Module attrbox.config
from . import env
PYTHON_KEYWORDS: List[
- str
+ LiteralString
] = """\
False await else import pass
None break except in raise
@@ -300,7 +301,7 @@ Module attrbox.config
Global variables
-var PYTHON_KEYWORDS : List[str]var PYTHON_KEYWORDS : List[LiteralString]-
diff --git a/docs/env.html b/docs/env.html
index f45477a..00a0420 100644
--- a/docs/env.html
+++ b/docs/env.html
@@ -113,6 +113,7 @@ Examples
def read(self) -> str:
"""Read the contents of the file-like object."""
+ return "" # pragma: no cover
def expand(
@@ -175,7 +176,7 @@ Examples
name = name.split(".")
if name in values:
- value = str(values[name])
+ value = str(values[name]) # pyright: ignore
return value
return _RE_EXPAND.sub(_repl, value)
@@ -478,7 +479,7 @@ Examples
name = name.split(".")
if name in values:
- value = str(values[name])
+ value = str(values[name]) # pyright: ignore
return value
return _RE_EXPAND.sub(_repl, value)
@@ -658,7 +659,7 @@ Examples
-def find_env(path: Union[pathlib.Path, str, None] = None, name: str = '.env') ‑> Optional[pathlib.Path]
+def find_env(path: Union[pathlib.Path, str, ForwardRef(None)] = None, name: str = '.env') ‑> Optional[pathlib.Path]
-
Find the .env file in the ancestors of the current path.
@@ -740,7 +741,7 @@ Examples
-def load_env(path: Union[pathlib.Path, str, None] = None) ‑> Dict[str, str]
+def load_env(path: Union[pathlib.Path, str, ForwardRef(None)] = None) ‑> Dict[str, str]
-
Load an environment file.
@@ -827,7 +828,8 @@ Classes
"""Protocol for a class that implements a `.read()` method."""
def read(self) -> str:
- """Read the contents of the file-like object."""
+ """Read the contents of the file-like object."""
+ return "" # pragma: no cover
Ancestors
@@ -846,7 +848,8 @@ Methods
Expand source code
def read(self) -> str:
- """Read the contents of the file-like object."""
+ """Read the contents of the file-like object."""
+ return "" # pragma: no cover
diff --git a/docs/fn.html b/docs/fn.html
index 3d5473c..5eb635f 100644
--- a/docs/fn.html
+++ b/docs/fn.html
@@ -64,6 +64,7 @@ Module attrbox.fn
def __contains__(self, key: Any) -> bool:
"""Return `True` if `key` exists, `False` otherwise."""
+ return False
def __getitem__(self, key: Any) -> Any:
"""Return value of `key`."""
@@ -516,11 +517,13 @@ Classes
Expand source code
-class SupportsItem(Protocol): # pragma: no cover
+@runtime_checkable
+class SupportsItem(Protocol): # pragma: no cover
"""Protocol for `k in x`, `x[k]`, and `x[k] = v`."""
def __contains__(self, key: Any) -> bool:
"""Return `True` if `key` exists, `False` otherwise."""
+ return False
def __getitem__(self, key: Any) -> Any:
"""Return value of `key`."""
diff --git a/docs/index.html b/docs/index.html
index 889f6e7..7d2a563 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -23,10 +23,15 @@ Package attrbox
Attribute-based data structures.
-
-
-
-Changelog - Issues - Documentation
+
+
+Otto the Otter
+
+
+
+
+
+
Why?
I have common use cases where I want to improve python's dict and list:
@@ -147,7 +152,7 @@ License
"""Attribute-based data structures.
.. include:: ../../README.md
- :start-line: 4
+ :start-line: 2
"""
# pkg
@@ -215,7 +220,7 @@ Sub-modules
Functions
-def load_env(path: Union[pathlib.Path, str, None] = None) ‑> Dict[str, str]
+def load_env(path: Union[pathlib.Path, str, ForwardRef(None)] = None) ‑> Dict[str, str]
-
Load an environment file.
@@ -533,16 +538,16 @@ Examples
"""
return self.__class__(super().copy())
- def __contains__(self, name: Any) -> bool:
- """Return `True` if `name` is a key.
+ def __contains__(self, key: Any) -> bool:
+ """Return `True` if `key` is a key.
Args:
- name (Any): typically a `AnyIndex`. If it's a string,
+ key (Any): typically a `AnyIndex`. If it's a string,
the check proceeds as usual. If it's a `Sequence`, the
checks are performed using `.get()`.
Returns:
- bool: `True` if the `name` is a valid key, `False` otherwise.
+ bool: `True` if the `key` is a valid key, `False` otherwise.
Examples:
Normal checking works as expected:
@@ -559,7 +564,7 @@ Examples
>>> ['a', 1, 'x'] in items
False
"""
- return self.get(name, NOT_FOUND) is not NOT_FOUND
+ return self.get(key, NOT_FOUND) is not NOT_FOUND
def __getattr__(self, name: str) -> Optional[Any]:
"""Return the value of the attribute or `None`.
@@ -659,11 +664,11 @@ Examples
except AttributeError: # use key/value
del self[name]
- def __getitem__(self, name: AnyIndex) -> Optional[Any]:
+ def __getitem__(self, key: AnyIndex) -> Optional[Any]:
"""Return the value of the key.
Args:
- name (AnyIndex): key name or Sequence of the path to a key
+ key (AnyIndex): key name or Sequence of the path to a key
Returns:
Any: value of the key or `None` if it cannot be found
@@ -675,13 +680,13 @@ Examples
>>> item['b'] is None
True
"""
- return self.get(name)
+ return self.get(key)
- def __setitem__(self, name: AnyIndex, value: Any) -> None:
+ def __setitem__(self, key: AnyIndex, value: Any) -> None:
"""Set the value of a key.
Args:
- name (BoxIndex): key name
+ key (AnyIndex): key name
value (Any): key value
Examples:
@@ -694,13 +699,13 @@ Examples
>>> item.a.b
10
"""
- self.set(name, value)
+ self.set(key, value)
- def __delitem__(self, name: str) -> None:
+ def __delitem__(self, key: str) -> None:
"""Delete a key.
Args:
- name (str): key name
+ key (str): key name
Examples:
>>> item = AttrDict(a=1)
@@ -715,7 +720,7 @@ Examples
{'a': 1}
"""
try:
- super().__delitem__(name)
+ super().__delitem__(key)
except KeyError:
pass
@@ -864,13 +869,13 @@ Examples
-def __contains__(self, name: Any) ‑> bool
+def __contains__(self, key: Any) ‑> bool
-
-
Return True if name is a key.
+Return True if key is a key.
Args
-name : Anykey : Any- typically a
AnyIndex. If it's a string,
the check proceeds as usual. If it's a Sequence, the
checks are performed using .get().
@@ -878,7 +883,7 @@ Args
Returns
boolTrue if the name is a valid key, False otherwise.True if the key is a valid key, False otherwise.
Examples
Normal checking works as expected:
@@ -899,16 +904,16 @@ Examples
Expand source code
-def __contains__(self, name: Any) -> bool:
- """Return `True` if `name` is a key.
+def __contains__(self, key: Any) -> bool:
+ """Return `True` if `key` is a key.
Args:
- name (Any): typically a `AnyIndex`. If it's a string,
+ key (Any): typically a `AnyIndex`. If it's a string,
the check proceeds as usual. If it's a `Sequence`, the
checks are performed using `.get()`.
Returns:
- bool: `True` if the `name` is a valid key, `False` otherwise.
+ bool: `True` if the `key` is a valid key, `False` otherwise.
Examples:
Normal checking works as expected:
@@ -925,7 +930,7 @@ Examples
>>> ['a', 1, 'x'] in items
False
"""
- return self.get(name, NOT_FOUND) is not NOT_FOUND
+ return self.get(key, NOT_FOUND) is not NOT_FOUND
@@ -1140,13 +1145,13 @@ Examples
-def __getitem__(self, name: AnyIndex) ‑> Optional[Any]
+def __getitem__(self, key: AnyIndex) ‑> Optional[Any]
-
Return the value of the key.
Args
-name : AnyIndexkey : AnyIndex- key name or Sequence of the path to a key
Returns
@@ -1165,11 +1170,11 @@ Examples
Expand source code
-def __getitem__(self, name: AnyIndex) -> Optional[Any]:
+def __getitem__(self, key: AnyIndex) -> Optional[Any]:
"""Return the value of the key.
Args:
- name (AnyIndex): key name or Sequence of the path to a key
+ key (AnyIndex): key name or Sequence of the path to a key
Returns:
Any: value of the key or `None` if it cannot be found
@@ -1181,17 +1186,17 @@ Examples
>>> item['b'] is None
True
"""
- return self.get(name)
+ return self.get(key)
-def __setitem__(self, name: AnyIndex, value: Any) ‑> None
+def __setitem__(self, key: AnyIndex, value: Any) ‑> None
-
Set the value of a key.
Args
-name : BoxIndexkey : AnyIndex- key name
value : Any- key value
@@ -1210,11 +1215,11 @@ Examples
Expand source code
-def __setitem__(self, name: AnyIndex, value: Any) -> None:
+def __setitem__(self, key: AnyIndex, value: Any) -> None:
"""Set the value of a key.
Args:
- name (BoxIndex): key name
+ key (AnyIndex): key name
value (Any): key value
Examples:
@@ -1227,17 +1232,17 @@ Examples
>>> item.a.b
10
"""
- self.set(name, value)
+ self.set(key, value)
-def __delitem__(self, name: str) ‑> None
+def __delitem__(self, key: str) ‑> None
-
Delete a key.
Args
-name : strkey : str- key name
Examples
@@ -1256,11 +1261,11 @@ Examples
Expand source code
-def __delitem__(self, name: str) -> None:
+def __delitem__(self, key: str) -> None:
"""Delete a key.
Args:
- name (str): key name
+ key (str): key name
Examples:
>>> item = AttrDict(a=1)
@@ -1275,7 +1280,7 @@ Examples
{'a': 1}
"""
try:
- super().__delitem__(name)
+ super().__delitem__(key)
except KeyError:
pass
@@ -2568,14 +2573,14 @@ Examples
Return a shallow copy …
-def __contains__(self, name: Any) ‑> bool
+def __contains__(self, key: Any) ‑> bool
-
Inherited from:
AttrDict.__contains__
-Return True if name is a key …
+Return True if key is a key …
def __getattr__(self, name: str) ‑> Optional[Any]
@@ -2608,7 +2613,7 @@ Examples
Delete an attribute …
-def __getitem__(self, name: AnyIndex) ‑> Optional[Any]
+def __getitem__(self, key: AnyIndex) ‑> Optional[Any]
-
@@ -2618,7 +2623,7 @@
Examples
Return the value of the key …
-def __setitem__(self, name: AnyIndex, value: Any) ‑> None
+def __setitem__(self, key: AnyIndex, value: Any) ‑> None
-
@@ -2628,7 +2633,7 @@
Examples
Set the value of a key …
-def __delitem__(self, name: str) ‑> None
+def __delitem__(self, key: str) ‑> None
-
diff --git a/docs/jsend.html b/docs/jsend.html
index dc5693b..49a73b5 100644
--- a/docs/jsend.html
+++ b/docs/jsend.html
@@ -460,14 +460,14 @@
Examples
Return a shallow copy …
-def __contains__(self, name: Any) ‑> bool
+def __contains__(self, key: Any) ‑> bool
-
Inherited from:
AttrDict.__contains__
-Return True if name is a key …
+Return True if key is a key …
def __getattr__(self, name: str) ‑> Optional[Any]
@@ -500,7 +500,7 @@ Examples
Delete an attribute …
-def __getitem__(self, name: AnyIndex) ‑> Optional[Any]
+def __getitem__(self, key: AnyIndex) ‑> Optional[Any]
-
@@ -510,7 +510,7 @@
Examples
Return the value of the key …
-def __setitem__(self, name: AnyIndex, value: Any) ‑> None
+def __setitem__(self, key: AnyIndex, value: Any) ‑> None
-
@@ -520,7 +520,7 @@
Examples
Set the value of a key …
-def __delitem__(self, name: str) ‑> None
+def __delitem__(self, key: str) ‑> None
-
diff --git a/otter-box.png b/otter-box.png
new file mode 100644
index 0000000..d275c40
Binary files /dev/null and b/otter-box.png differ
diff --git a/pyproject.toml b/pyproject.toml
index 4d9cc5c..2dbc362 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -36,6 +36,7 @@ optional-dependencies = { dev = [
"mypy",
"pdm",
"pdoc3",
+ "pyright",
"pytest-cov",
"pytest",
"ruff",
@@ -56,6 +57,7 @@ classifiers = [
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
+ "Programming Language :: Python :: 3.12",
"Topic :: Software Development :: Libraries",
"Typing :: Typed",
]
@@ -64,6 +66,7 @@ classifiers = [
black = { shell = "black ." }
ruff = { shell = "ruff ." }
cspell = { shell = "cspell --gitignore '**/*.{py,txt,md,markdown}'" }
+pyright = { shell = "pyright src test" }
mypy = { shell = """\
mypy \
@@ -92,8 +95,9 @@ docs = { shell = """\
--config show_inherited_members=True \
--force src/$(basename $(pwd));
mv docs/**/* docs/
+ touch docs/.nojekyll
""" }
-lint = { composite = ["black", "ruff", "cspell", "mypy"] }
+lint = { composite = ["black", "ruff", "cspell", "pyright", "mypy"] }
dev = { composite = ["lint", "test"] }
all = { composite = ["lint", "test", "docs"] }
diff --git a/src/attrbox/__init__.py b/src/attrbox/__init__.py
index afb4ce2..9205f20 100644
--- a/src/attrbox/__init__.py
+++ b/src/attrbox/__init__.py
@@ -1,7 +1,7 @@
"""Attribute-based data structures.
.. include:: ../../README.md
- :start-line: 4
+ :start-line: 2
"""
# pkg