chore: few type hints for model

Author: dimaqq

juju/model.py

@@ -19,6 +19,7 @@
 from datetime import datetime, timedelta
 from functools import partial
 from pathlib import Path
+from typing import Any
 
 import websockets
 import yaml
@@ -28,6 +29,7 @@
 from .bundle import BundleHandler, get_charm_series, is_local_charm
 from .charmhub import CharmHub
 from .client import client, connector
+from .client.connection import Connection
 from .client.overrides import Caveat, Macaroon
 from .constraints import parse as parse_constraints
 from .controller import ConnectedController, Controller
@@ -257,7 +259,9 @@ def get_entity(self, entity_type, entity_id, history_index=-1, connected=True):
 class ModelEntity:
     """An object in the Model tree"""
 
-    def __init__(self, entity_id, model, history_index=-1, connected=True):
+    entity_id: str
+
+    def __init__(self, entity_id: str, model: Model, history_index=-1, connected=True):
         """Initialize a new entity
 
         :param entity_id str: The unique id of the object in the model
@@ -279,7 +283,7 @@ def __init__(self, entity_id, model, history_index=-1, connected=True):
     def __repr__(self):
         return f'<{type(self).__name__} entity_id="{self.entity_id}">'
 
-    def __getattr__(self, name):
+    def __getattr__(self, name: str) -> Any:
         """Fetch object attributes from the underlying data dict held in the
         model.
 
@@ -615,7 +619,7 @@ def is_connected(self):
         """Reports whether the Model is currently connected."""
         return self._connector.is_connected()
 
-    def connection(self):
+    def connection(self) -> Connection:
         """Return the current Connection object. It raises an exception
         if the Model is disconnected
         """
@@ -3227,16 +3231,16 @@ def make_archive(self, path):
         zf.close()
         return path
 
-    def _check_type(self, path):
+    def _check_type(self, path: str) -> str:
         """Check the path"""
-        s = os.stat(str(path))
+        s = os.stat(path)
         if stat.S_ISDIR(s.st_mode) or stat.S_ISREG(s.st_mode):
             return path
         raise ValueError(
             "Invalid Charm at %s %s" % (path, "Invalid file type for a charm")
         )
 
-    def _check_link(self, path):
+    def _check_link(self, path: str) -> None:
         link_path = os.readlink(path)
         if link_path[0] == "/":
             raise ValueError(
@@ -3249,7 +3253,9 @@ def _check_link(self, path):
                 "Invalid charm at %s %s" % (path, "Only internal symlinks are allowed")
             )
 
-    def _write_symlink(self, zf, link_target, link_path):
+    def _write_symlink(
+        self, zf: zipfile.ZipFile, link_target: str, link_path: str
+    ) -> None:
         """Package symlinks with appropriate zipfile metadata."""
         info = zipfile.ZipInfo()
         info.filename = link_path
@@ -3259,11 +3265,8 @@ def _write_symlink(self, zf, link_target, link_path):
         info.external_attr = 2716663808
         zf.writestr(info, link_target)
 
-    def _ignore(self, path):
-        if path == "build" or path.startswith("build/"):
-            return True
-        if path.startswith("."):
-            return True
+    def _ignore(self, path: str) -> bool:
+        return path == "build" or path.startswith("build/") or path.startswith(".")
 
 
 class ModelInfo(ModelEntity):

juju/tag.py

@@ -1,63 +1,64 @@
 # Copyright 2023 Canonical Ltd.
 # Licensed under the Apache V2, see LICENCE file for details.
+from __future__ import annotations
 
 # TODO: Tags should be a proper class, so that we can distinguish whether
 # something is already a tag or not.  For example, 'user-foo' is a valid
 # username, but is ambiguous with the already-tagged username 'foo'.
 
 
-def _prefix(prefix, s):
+def _prefix(prefix: str, s: str) -> str:
     if s and not s.startswith(prefix):
         return f"{prefix}{s}"
     return s
 
 
-def untag(prefix, s):
+def untag(prefix: str, s: str) -> str:
     if s and s.startswith(prefix):
         return s[len(prefix) :]
     return s
 
 
-def cloud(cloud_name):
+def cloud(cloud_name: str) -> str:
     return _prefix("cloud-", cloud_name)
 
 
-def controller(controller_uuid):
+def controller(controller_uuid: str) -> str:
     return _prefix("controller-", controller_uuid)
 
 
-def credential(cloud, user, credential_name):
+def credential(cloud: str, user: str, credential_name: str) -> str:
     credential_string = f"{cloud}_{user}_{credential_name}"
     return _prefix("cloudcred-", credential_string)
 
 
-def model(model_uuid):
+def model(model_uuid: str) -> str:
     return _prefix("model-", model_uuid)
 
 
-def machine(machine_id):
+def machine(machine_id: str) -> str:
     return _prefix("machine-", machine_id)
 
 
-def user(username):
+def user(username: str) -> str:
     return _prefix("user-", username)
 
 
-def application(app_name):
+def application(app_name: str) -> str:
     return _prefix("application-", app_name)
 
 
-def storage(app_name):
+def storage(app_name: str) -> str:
     return _prefix("storage-", app_name)
 
 
-def unit(unit_name):
+def unit(unit_name: str) -> str:
     return _prefix("unit-", unit_name.replace("/", "-"))
 
 
-def action(action_uuid):
+def action(action_uuid: str) -> str:
     return _prefix("action-", action_uuid)
 
 
-def space(space_name):
+def space(space_name: str) -> str:
     return _prefix("space-", space_name)