Expand the amount of files checked by codespell (canonical#79)

* Expand files checked by codespell

* Bump libs

Author: dragomirp

lib/charms/operator_libs_linux/v0/apt.py

@@ -78,7 +78,6 @@
 Repositories can be added with explicit values through a Python constructor.
 
 Example:
-
 ```python
 repositories = apt.RepositoryMapping()
 
@@ -91,7 +90,6 @@
 `DebianRepository`.
 
 Example:
-
 ```python
 repositories = apt.RepositoryMapping()
 
@@ -124,7 +122,7 @@
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 10
+LIBPATCH = 11
 
 
 VALID_SOURCE_TYPES = ("deb", "deb-src")
@@ -135,7 +133,7 @@ class Error(Exception):
     """Base class of most errors raised by this library."""
 
     def __repr__(self):
-        """String representation of Error."""
+        """Represent the Error."""
         return "<{}.{} {}>".format(type(self).__module__, type(self).__name__, self.args)
 
     @property
@@ -212,15 +210,15 @@ def __eq__(self, other) -> bool:
         ) == (other._name, other._version.number)
 
     def __hash__(self):
-        """A basic hash so this class can be used in Mappings and dicts."""
+        """Return a hash of this package."""
         return hash((self._name, self._version.number))
 
     def __repr__(self):
-        """A representation of the package."""
+        """Represent the package."""
         return "<{}.{}: {}>".format(self.__module__, self.__class__.__name__, self.__dict__)
 
     def __str__(self):
-        """A human-readable representation of the package."""
+        """Return a human-readable representation of the package."""
         return "<{}: {}-{}.{} -- {}>".format(
             self.__class__.__name__,
             self._name,
@@ -267,7 +265,7 @@ def _add(self) -> None:
         )
 
     def _remove(self) -> None:
-        """Removes a package from the system. Implementation-specific."""
+        """Remove a package from the system. Implementation-specific."""
         return self._apt("remove", "{}={}".format(self.name, self.version))
 
     @property
@@ -276,7 +274,7 @@ def name(self) -> str:
         return self._name
 
     def ensure(self, state: PackageState):
-        """Ensures that a package is in a given state.
+        """Ensure that a package is in a given state.
 
         Args:
           state: a `PackageState` to reconcile the package to
@@ -308,7 +306,7 @@ def state(self) -> PackageState:
 
     @state.setter
     def state(self, state: PackageState) -> None:
-        """Sets the package state to a given value.
+        """Set the package state to a given value.
 
         Args:
           state: a `PackageState` to reconcile the package to
@@ -527,11 +525,11 @@ def __init__(self, version: str, epoch: str):
         self._epoch = epoch or ""
 
     def __repr__(self):
-        """A representation of the package."""
+        """Represent the package."""
         return "<{}.{}: {}>".format(self.__module__, self.__class__.__name__, self.__dict__)
 
     def __str__(self):
-        """A human-readable representation of the package."""
+        """Return human-readable representation of the package."""
         return "{}{}".format("{}:".format(self._epoch) if self._epoch else "", self._version)
 
     @property
@@ -732,6 +730,7 @@ def add_package(
     """Add a package or list of packages to the system.
 
     Args:
+        package_names: single package name, or list of package names
         name: the name(s) of the package(s)
         version: an (Optional) version as a string. Defaults to the latest known
         arch: an optional architecture for the package
@@ -788,7 +787,7 @@ def _add(
     version: Optional[str] = "",
     arch: Optional[str] = "",
 ) -> Tuple[Union[DebianPackage, str], bool]:
-    """Adds a package.
+    """Add a package to the system.
 
     Args:
         name: the name(s) of the package(s)
@@ -809,7 +808,7 @@ def _add(
 def remove_package(
     package_names: Union[str, List[str]]
 ) -> Union[DebianPackage, List[DebianPackage]]:
-    """Removes a package from the system.
+    """Remove package(s) from the system.
 
     Args:
         package_names: the name of a package
@@ -837,7 +836,7 @@ def remove_package(
 
 
 def update() -> None:
-    """Updates the apt cache via `apt-get update`."""
+    """Update the apt cache via `apt-get update`."""
     check_call(["apt-get", "update"], stderr=PIPE, stdout=PIPE)
 
 
@@ -966,7 +965,7 @@ def filename(self):
 
     @filename.setter
     def filename(self, fname: str) -> None:
-        """Sets the filename used when a repo is written back to diskself.
+        """Set the filename used when a repo is written back to disk.
 
         Args:
             fname: a filename to write the repository information to.
@@ -1148,7 +1147,7 @@ def _get_key_by_keyid(keyid: str) -> str:
 
     @staticmethod
     def _dearmor_gpg_key(key_asc: bytes) -> bytes:
-        """Converts a GPG key in the ASCII armor format to the binary format.
+        """Convert a GPG key in the ASCII armor format to the binary format.
 
         Args:
           key_asc: A GPG key in ASCII armor format.
@@ -1172,7 +1171,7 @@ def _dearmor_gpg_key(key_asc: bytes) -> bytes:
 
     @staticmethod
     def _write_apt_gpg_keyfile(key_name: str, key_material: bytes) -> None:
-        """Writes GPG key material into a file at a provided path.
+        """Write GPG key material into a file at a provided path.
 
         Args:
           key_name: A key name to use for a key file (could be a fingerprint)
@@ -1220,7 +1219,7 @@ def __len__(self) -> int:
         return len(self._repository_map)
 
     def __iter__(self) -> Iterable[DebianRepository]:
-        """Iterator magic method for RepositoryMapping."""
+        """Return iterator for RepositoryMapping."""
         return iter(self._repository_map.values())
 
     def __getitem__(self, repository_uri: str) -> DebianRepository:

lib/charms/operator_libs_linux/v1/systemd.py

@@ -60,21 +60,23 @@
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 1
+LIBPATCH = 2
 
 
 class SystemdError(Exception):
+    """Custom exception for SystemD related errors."""
+
     pass
 
 
 def _popen_kwargs():
-    return dict(
-        stdout=subprocess.PIPE,
-        stderr=subprocess.STDOUT,
-        bufsize=1,
-        universal_newlines=True,
-        encoding="utf-8",
-    )
+    return {
+        "stdout": subprocess.PIPE,
+        "stderr": subprocess.STDOUT,
+        "bufsize": 1,
+        "universal_newlines": True,
+        "encoding": "utf-8",
+    }
 
 
 def _systemctl(

tests/integration/new_relations/test_new_relations.py

@@ -71,7 +71,7 @@ async def test_no_read_only_endpoint_in_standalone_cluster(ops_test: OpsTest):
     """Test that there is no read-only endpoint in a standalone cluster."""
     async with ops_test.fast_forward():
         # Ensure the cluster starts with only one member.
-        # We cant scale down a running cluster to 1 unit because the way
+        # We can't scale down a running cluster to 1 unit because the way
         # Patroni raft implementation works (to scale from 2 units to 1 Patroni
         # needs at least one mode unit that run only raft to have quorum).
         assert len(ops_test.model.applications[DATABASE_APP_NAME].units) == 1

tests/unit/test_charm.py

@@ -493,7 +493,7 @@ def test_install_pip_package(self, _call):
 
         _call.side_effect = [None, subprocess.SubprocessError]
 
-        # Then test for a succesful install.
+        # Then test for a successful install.
         self.charm._install_pip_package(package)
         # Check that check_call was invoked with the correct arguments.
         _call.assert_called_once_with(

tox.ini

@@ -10,6 +10,8 @@ env_list = lint, unit
 src_path = {tox_root}/src
 tests_path = {tox_root}/tests
 ;lib_path = {tox_root}/lib/charms/operator_name_with_underscores
+test_ha_charm_libs = {tox_root}tests/integration/ha_tests/application-charm/lib
+test_rel_charm_libs = {tox_root}tests/integration/new_relations/application-charm/lib
 all_path = {[vars]src_path} {[vars]tests_path}
 
 [testenv]
@@ -36,8 +38,10 @@ commands =
 description = Check code against coding style standards
 commands =
     poetry install --only format,lint
-    poetry run codespell {tox_root}/*.yaml {tox_root}/*.ini {tox_root}/*.md \
-      {tox_root}/*.toml {tox_root}/*.txt {tox_root}/.github
+    poetry run codespell {tox_root} --skip {tox_root}/.git --skip {tox_root}/.tox \
+      --skip {tox_root}/build --skip {tox_root}/lib --skip {tox_root}/venv \
+      --skip {tox_root}/.mypy_cache --skip {tox_root}/LICENSE --skip {tox_root}/poetry.lock \
+      --skip {[vars]test_ha_charm_libs} --skip {[vars]test_rel_charm_libs}
     # pflake8 wrapper supports config from pyproject.toml
     poetry run pflake8 {[vars]all_path}
     poetry run isort --check-only --diff {[vars]all_path}