classicist 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

classicist/decorators/aliased/__init__.py

@@ -46,7 +46,7 @@ def alias(*names: tuple[str], scope: object = None) -> Callable:
 
         thing = unwrap(thing)
 
-        logger.info(f"@alias({names}) called on {thing}")
+        logger.debug(f"@alias({names}) called on {thing}")
 
         if isinstance(aliases := getattr(thing, "_classicist_aliases", None), tuple):
             setattr(thing, "_classicist_aliases", tuple([*aliases, *names]))
@@ -55,7 +55,7 @@ def alias(*names: tuple[str], scope: object = None) -> Callable:
 
         @wraps(thing)
         def wrapper_class(*args, **kwargs):
-            return thing  # (*args, **kwargs)
+            return thing
 
         @wraps(thing)
         def wrapper_method(*args, **kwargs):
@@ -63,7 +63,7 @@ def alias(*names: tuple[str], scope: object = None) -> Callable:
 
         @wraps(thing)
         def wrapper_function(*args, **kwargs):
-            return thing  # (*args, **kwargs)
+            return thing
 
         if inspect.isclass(thing):
             if not scope:
@@ -94,24 +94,18 @@ def alias(*names: tuple[str], scope: object = None) -> Callable:
             if not scope:
                 scope = sys.modules.get(thing.__module__ or "__main__")
 
-            if not scope:
-                logger.warning(f"No module found for {thing.__module__}!")
-
-                for module in sys.modules:
-                    logger.debug(f" => module => {module}")
-
-            # The qualified name for module-level functions only contain the name of the
-            # function, whereas functions nested within other functions or classes have
-            # names comprised of multiple parts separated by the "." character; because
-            # it is only currently possible to alias module-level functions, any nested
-            # or class methods are ignored during this stage of the aliasing process.
-            if len(thing.__qualname__.split(".")) > 1:
-                logger.warning(
-                    "Unable to apply alias to functions defined beyond the top-level of a module: %s!"
-                    % (thing.__qualname__)
-                )
+                # The qualified name for module-level functions only contain the name of the
+                # function, whereas functions nested within other functions or classes have
+                # names comprised of multiple parts separated by the "." character; because
+                # it is only currently possible to alias module-level functions, any nested
+                # or class methods are ignored during this stage of the aliasing process.
+                if len(thing.__qualname__.split(".")) > 1:
+                    logger.debug(
+                        "Unable to apply alias to functions defined beyond the top-level of a module: %s!"
+                        % (thing.__qualname__)
+                    )
 
-                return wrapper_function(*args, **kwargs)
+                    return wrapper_function(*args, **kwargs)
 
             # if signature := inspect.signature(thing):
             #     if len(parameters := signature.parameters) > 0 and "self" in parameters:
@@ -131,7 +125,7 @@ def alias(*names: tuple[str], scope: object = None) -> Callable:
                             )
                         )
 
-                    logger.info(f"Added alias '{name}' to {scope}.{thing}")
+                    logger.debug(f"Added alias '{name}' to {scope}.{thing}")
 
                     if isinstance(scope, dict):
                         scope[name] = thing
@@ -139,7 +133,7 @@ def alias(*names: tuple[str], scope: object = None) -> Callable:
                         setattr(scope, name, thing)
             else:
                 logger.warning(
-                    f"No scope was found or specified for {thing} into which to assign the alias!"
+                    f"No scope was found or specified for {thing} into which to assign aliases!"
                 )
 
             return wrapper_function(*args, **kwargs)

classicist/version.txt

@@ -1 +1 @@
-1.0.2
+1.0.3

{classicist-1.0.2.dist-info → classicist-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: classicist
-Version: 1.0.2
+Version: 1.0.3
 Summary: Classy class decorators for Python.
 Author: Daniel Sissman
 License-Expression: MIT
@@ -39,7 +39,7 @@ The Classicist library provides several useful decorators and helper methods inc
  * `@classproperty` – a decorator that allow class methods to be accessed as class properties;
  * `@annotation` – a decorator that can be used to apply arbitrary annotations to code objects;
  * `@deprecated` – a decorator that can be used to mark functions, classes and methods as being deprecated;
- * `@alias` – a decorator that can be used to add aliases to class methods;
+ * `@alias` – a decorator that can be used to add aliases to classes, methods defined within classes, module-level functions, and nested functions when overriding the aliasing scope;
  * `@nocache` – a decorator that can be used to mark functions and methods as not being suitable for caching;
  * `shadowproof` – a metaclass that can be used to protect subclasses from class-level attributes
   being overwritten (or shadowed) which can otherwise negatively affect class behaviour in some cases.
@@ -263,32 +263,35 @@ exampleclass.greeting = "goodbye"
 assert exampleclass.greeting == "goodbye"
 ```
 
-#### Class Method Alias Decorator & Metaclass: Add Aliases to Methods
+#### Alias Decorator & Metaclass: Add Aliases to Classes, Methods & Functions
 
 The `@alias` decorator can be used to add aliases to classes, methods defined within
-classes, and module-level functions, such that both the original name and any defined
-aliases can be used to access the same code object at runtime.
+classes, module-level functions, and nested functions when overriding the aliasing scope,
+such that both the original name and any defined aliases can be used to access the same
+code object at runtime.
 
 To alias a class or a module-level function, that is a function defined at the top-level
 of a module file (rather than nested within a function or class), simply decorate the 
 class or module-level function with the `@alias(...)` decorator and specify the one or
-more name aliases for the code object as one or more string arguments passed into the
-decorator method.
+more name aliases for the class or function as one or more string arguments passed into
+the decorator method.
 
 To use the `@alias` decorator on methods defined within a class, it is also necessary to
 set the containing class' metaclass to the `aliased` metaclass provided by the `classicist`
-library; the metaclass iterates through the class namespace during parse time and sets up
+library; the metaclass iterates through the class' namespace during parse time and sets up
 the aliases as additional attributes on the class so that the aliased methods are available
-at runtime via both their original name and their aliases.
-
-The example below demonstrates adding an alias to a method defined within a class, and
-using the `aliased` metaclass when defining the class to ensure that the alias is parsed
-and translated to an additional class attribute so that the method is accessible via its
-original name and the alias at runtime.
-
-If control over the scope is required, the optional `scope` keyword argument can be
-used to specify the scope into which to apply the alias, this must be a reference to
-the globals() or locals() at the point in code where the `@alias()` decorator is used.
+at runtime via both their original name and any aliases.
+
+The examples below demonstrate adding an alias to a module-level function, a class and a
+method defined within a class, and using the `aliased` metaclass when defining a class
+that contains aliased methods to ensure that any aliases are parsed and translated to
+additional class attributes so that the method is accessible via its original name and
+any alias at runtime.
+
+If control over the scope is required, usually for nested functions, the optional `scope`
+keyword-only argument can be used to specify the scope into which to apply the alias; this
+must be a reference to `globals()` or `locals()` at the point in code where the `@alias(...)`
+decorator is applied to the nested function.
 
 ```python
 from classicist import aliased, alias, is_aliased, aliases

{classicist-1.0.2.dist-info → classicist-1.0.3.dist-info}/RECORD

@@ -1,7 +1,7 @@
 classicist/__init__.py,sha256=Rkm1Vx0Z-BHPH1FSzFLrAxwkFEt1xvMxZz-mC8FJSDc,834
-classicist/version.txt,sha256=v-wuNFg62n5q8stzmT-3Wj9xR6bJQ-X_X1xClPxXe5A,5
+classicist/version.txt,sha256=INLLCW0atBpBQCRtEvB79rjLdD_UgSK3JTLAPUTFwUo,5
 classicist/decorators/__init__.py,sha256=wplcs2JnyGMOh72626-x-WyVotVoT7nvk-dpjeTXQ88,600
-classicist/decorators/aliased/__init__.py,sha256=e62ENmJh_kH4Ufh9duAYWg93cfmINIcpzeP0haJo7cw,7132
+classicist/decorators/aliased/__init__.py,sha256=vW1P9jbGkOD_m9GvgEXF0Uni-Dt6rfVXDVF5D4wC1GY,6926
 classicist/decorators/annotation/__init__.py,sha256=20WwmrXDxT85sItpDiCdC-hZjbyDR6E2mLPMSKQgm8g,1796
 classicist/decorators/classproperty/__init__.py,sha256=ED37_20UeAGKX1ahsv16wTg0JAJT4UBLqiNRbKAp2KE,1646
 classicist/decorators/deprecated/__init__.py,sha256=aAPFQoT-pJf1nauQGiPADkPBREMvEQJaUQc3kjA48Rg,2764
@@ -18,9 +18,9 @@ classicist/logging/__init__.py,sha256=LJ-Nih1LacPrO2TvTT6l84So-pgw84AHJ8IhzYKl5r
 classicist/metaclasses/__init__.py,sha256=mYhR5rM7cnJlaNUlgoQWOo44RQSORteRjYd0y0BajxQ,159
 classicist/metaclasses/aliased/__init__.py,sha256=grs4Z8dMY6R2fCFn4UCPdCzEJtVaAv-tsWFwY1DCUpI,2033
 classicist/metaclasses/shadowproof/__init__.py,sha256=d55uNjcaCorD3MdDUv7aRVpk2MlE8JzMjint6Vvf_Yc,1492
-classicist-1.0.2.dist-info/licenses/LICENSE.md,sha256=qBmrjPmSCp0YFyaIl2G3FU3rniFD31YC0Yd3MrO1wEg,1070
-classicist-1.0.2.dist-info/METADATA,sha256=g3SDEBecgGq15CnHFUVr2mfyhFNQ3tG752I5OSMaAbk,24825
-classicist-1.0.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-classicist-1.0.2.dist-info/top_level.txt,sha256=beG3ZuwObnmnY_mgNSN5CaVIWpI2VKszjVdKHPgZBhc,11
-classicist-1.0.2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-classicist-1.0.2.dist-info/RECORD,,
+classicist-1.0.3.dist-info/licenses/LICENSE.md,sha256=qBmrjPmSCp0YFyaIl2G3FU3rniFD31YC0Yd3MrO1wEg,1070
+classicist-1.0.3.dist-info/METADATA,sha256=iZaQqjD9wd84Bb_Dx_Se-RMYgZTvvf2Hkf2idrnswgk,25128
+classicist-1.0.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+classicist-1.0.3.dist-info/top_level.txt,sha256=beG3ZuwObnmnY_mgNSN5CaVIWpI2VKszjVdKHPgZBhc,11
+classicist-1.0.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+classicist-1.0.3.dist-info/RECORD,,