Rename PackageConfig.label to PackageConfig.package_label

Author: davegaeddert

plain-admin/plain/admin/config.py

@@ -6,7 +6,7 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plainadmin"
+    package_label = "plainadmin"
 
     def ready(self):
         def _import_if_exists(module_name):

plain-api/plain/api/config.py

@@ -3,4 +3,4 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plainapi"  # Primarily for migrations
+    package_label = "plainapi"  # Primarily for migrations

plain-cache/plain/cache/config.py

@@ -3,4 +3,4 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plaincache"
+    package_label = "plaincache"

plain-flags/plain/flags/config.py

@@ -3,4 +3,4 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plainflags"  # Primarily for migrations
+    package_label = "plainflags"  # Primarily for migrations

plain-models/plain/models/backends/base/creation.py

@@ -104,7 +104,7 @@ def set_as_test_mirror(self, primary_settings_dict):
     #         for package_config in packages.get_package_configs():
     #             if (
     #                 package_config.models_module is not None
-    #                 and package_config.label in loader.migrated_packages
+    #                 and package_config.package_label in loader.migrated_packages
     #             ):
     #                 for model in package_config.get_models():
     #                     if model._meta.can_migrate(

plain-models/plain/models/backends/base/introspection.py

@@ -86,7 +86,7 @@ def get_migratable_models(self):
             model
             for package_config in packages_registry.get_package_configs()
             for model in router.get_migratable_models(
-                models_registry, package_config.label, self.connection.alias
+                models_registry, package_config.package_label, self.connection.alias
             )
             if model._meta.can_migrate(self.connection)
         )

plain-models/plain/models/base.py

@@ -130,7 +130,7 @@ def _setup_meta(cls):
                     "INSTALLED_PACKAGES."
                 )
             else:
-                package_label = package_config.label
+                package_label = package_config.package_label
 
         cls.add_to_class("_meta", Options(meta, package_label))
 

plain-models/plain/models/cli.py

@@ -317,7 +317,7 @@ def all_items_equal(seq):
 
     # Raise an error if any migrations are applied before their dependencies.
     consistency_check_labels = {
-        config.label for config in packages_registry.get_package_configs()
+        config.package_label for config in packages_registry.get_package_configs()
     }
     # Non-default databases are only checked if database routers used.
     aliases_to_check = connections if settings.DATABASE_ROUTERS else [DEFAULT_DB_ALIAS]

plain-models/plain/models/migrations/loader.py

@@ -78,9 +78,9 @@ def load_disk(self):
         self.migrated_packages = set()
         for package_config in packages_registry.get_package_configs():
             # Get the migrations module directory
-            module_name, explicit = self.migrations_module(package_config.label)
+            module_name, explicit = self.migrations_module(package_config.package_label)
             if module_name is None:
-                self.unmigrated_packages.add(package_config.label)
+                self.unmigrated_packages.add(package_config.package_label)
                 continue
             was_loaded = module_name in sys.modules
             try:
@@ -89,26 +89,26 @@ def load_disk(self):
                 if (explicit and self.ignore_no_migrations) or (
                     not explicit and MIGRATIONS_MODULE_NAME in e.name.split(".")
                 ):
-                    self.unmigrated_packages.add(package_config.label)
+                    self.unmigrated_packages.add(package_config.package_label)
                     continue
                 raise
             else:
                 # Module is not a package (e.g. migrations.py).
                 if not hasattr(module, "__path__"):
-                    self.unmigrated_packages.add(package_config.label)
+                    self.unmigrated_packages.add(package_config.package_label)
                     continue
                 # Empty directories are namespaces. Namespace packages have no
                 # __file__ and don't use a list for __path__. See
                 # https://docs.python.org/3/reference/import.html#namespace-packages
                 if getattr(module, "__file__", None) is None and not isinstance(
                     module.__path__, list
                 ):
-                    self.unmigrated_packages.add(package_config.label)
+                    self.unmigrated_packages.add(package_config.package_label)
                     continue
                 # Force a reload if it's already loaded (tests need this)
                 if was_loaded:
                     reload(module)
-            self.migrated_packages.add(package_config.label)
+            self.migrated_packages.add(package_config.package_label)
             migration_names = {
                 name
                 for _, name, is_pkg in pkgutil.iter_modules(module.__path__)
@@ -129,12 +129,12 @@ def load_disk(self):
                         raise
                 if not hasattr(migration_module, "Migration"):
                     raise BadMigrationError(
-                        f"Migration {migration_name} in app {package_config.label} has no Migration class"
+                        f"Migration {migration_name} in app {package_config.package_label} has no Migration class"
                     )
-                self.disk_migrations[package_config.label, migration_name] = (
+                self.disk_migrations[package_config.package_label, migration_name] = (
                     migration_module.Migration(
                         migration_name,
-                        package_config.label,
+                        package_config.package_label,
                     )
                 )
 

plain-models/plain/models/migrations/questioner.py

@@ -38,7 +38,7 @@ def ask_initial(self, package_label):
         except LookupError:  # It's a fake app.
             return self.defaults.get("ask_initial", False)
         migrations_import_path, _ = MigrationLoader.migrations_module(
-            package_config.label
+            package_config.package_label
         )
         if migrations_import_path is None:
             # It's an application with migrations disabled.

plain-models/plain/models/preflight.py

@@ -32,7 +32,7 @@ def check_all_models(package_configs=None, **kwargs):
         models = models_registry.get_models()
     else:
         models = chain.from_iterable(
-            models_registry.get_models(package_label=package_config.label)
+            models_registry.get_models(package_label=package_config.package_label)
             for package_config in package_configs
         )
     for model in models:

plain-oauth/plain/oauth/config.py

@@ -3,4 +3,4 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plainoauth"  # Primarily for migrations
+    package_label = "plainoauth"  # Primarily for migrations

plain-pageviews/plain/pageviews/config.py

@@ -3,4 +3,4 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plainpageviews"
+    package_label = "plainpageviews"

plain-redirection/plain/redirection/config.py

@@ -3,4 +3,4 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plainredirection"
+    package_label = "plainredirection"

plain-sessions/plain/sessions/config.py

@@ -3,4 +3,4 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plainsessions"
+    package_label = "plainsessions"

plain-support/plain/support/config.py

@@ -3,4 +3,4 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plainsupport"
+    package_label = "plainsupport"

plain-worker/plain/worker/config.py

@@ -10,7 +10,7 @@
 
 @register_config
 class Config(PackageConfig):
-    label = "plainworker"
+    package_label = "plainworker"
 
     def ready(self):
         # Trigger register calls to fire by importing the modules

plain/plain/packages/config.py

@@ -10,36 +10,28 @@
 class PackageConfig:
     """Class representing a Plain application and its configuration."""
 
-    def __init__(self, name, *, label=""):
+    package_label: str
+
+    def __init__(self, name):
         # Full Python path to the application e.g. 'plain.admin.admin'.
         self.name = name
 
         # Reference to the Packages registry that holds this PackageConfig. Set by the
         # registry when it registers the PackageConfig instance.
         self.packages_registry = None
 
-        # The following attributes could be defined at the class level in a
-        # subclass, hence the test-and-set pattern.
-        if label and hasattr(self, "label"):
-            raise ImproperlyConfigured(
-                "PackageConfig class should not define a class label attribute and an init label"
-            )
-
-        if label:
-            # Set the label explicitly from the init
-            self.label = label
-        elif not hasattr(self, "label"):
+        if not hasattr(self, "package_label"):
             # Last component of the Python path to the application e.g. 'admin'.
             # This value must be unique across a Plain project.
-            self.label = self.name.rpartition(".")[2]
+            self.package_label = self.name.rpartition(".")[2]
 
-        if not self.label.isidentifier():
+        if not self.package_label.isidentifier():
             raise ImproperlyConfigured(
-                f"The app label '{self.label}' is not a valid Python identifier."
+                f"The app label '{self.package_label}' is not a valid Python identifier."
             )
 
     def __repr__(self):
-        return f"<{self.__class__.__name__}: {self.label}>"
+        return f"<{self.__class__.__name__}: {self.package_label}>"
 
     @cached_property
     def path(self):

plain/plain/packages/registry.py

@@ -146,7 +146,7 @@ def get_package_config(self, package_label):
             message = f"No installed app with label '{package_label}'."
             for package_config in self.get_package_configs():
                 if package_config.name == package_label:
-                    message += f" Did you mean '{package_config.label}'?"
+                    message += f" Did you mean '{package_config.package_label}'?"
                     break
             raise LookupError(message)
 
@@ -179,11 +179,11 @@ def register_config(self, package_config):
         class Config(PackageConfig):
             pass
         """
-        if package_config.label in self.package_configs:
+        if package_config.package_label in self.package_configs:
             raise ImproperlyConfigured(
-                f"Package labels aren't unique, duplicates: {package_config.label}"
+                f"Package labels aren't unique, duplicates: {package_config.package_label}"
             )
-        self.package_configs[package_config.label] = package_config
+        self.package_configs[package_config.package_label] = package_config
         package_config.packages = self
 
         return package_config