clsproperties 1.0.0__tar.gz

clsproperties-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,49 @@
+name: Publish Python Package to PyPi on Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download Repository Content to Machine
+        uses: actions/checkout@v4
+
+      - name: Set up Python Environment
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install Build Package
+        run: python -m pip install --upgrade build
+
+      - name: Build Package
+        run: python -m build
+
+      - name: Upload Build Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: package-dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download Build Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: package-dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

clsproperties-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Isaac Bell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

clsproperties-1.0.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: clsproperties
+Version: 1.0.0
+Summary: Provides classproperty objects for controlled access to class attributes.
+Project-URL: Source, https://github.com/icb08/clsproperties
+Project-URL: Issues, https://github.com/icb08/clsproperties/issues
+Project-URL: Documentation, https://github.com/icb08/clsproperties/wiki/Documentation
+Project-URL: Changelog, https://github.com/icb08/clsproperties/wiki/Changelog
+Project-URL: License, https://github.com/icb08/clsproperties/blob/main/LICENSE
+Author: Isaac Bell
+License-Expression: MIT
+Keywords: attribute,attributes,class,classattribute,classattributes,classproperties,classproperty,deleter,descriptor,getter,metaclass,properties,property,pypi,python,python-3,python-library,python-module,python-package,python3,setter
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# clsproperties
+- **Author:** [Isaac Bell](https://github.com/icb08)
+- **Version:** [1.0.0](https://github.com/icb08/clsproperties/wiki/Changelog#1-0-0)
+
+This library provides `classproperty` objects for controlled access to class attributes.
+
+The `classproperty` class aims to emulate the behaviours of Python's built-in `property` class, providing controlled access to class attributes instead of instance attributes. Like `property` objects, `classproperty` objects support use both as a decorator and as a callable. Like `property` objects, `classproperty` objects are descriptors, supporting getter, setter and deleter functions. 
+
+## Links
+- **[Source Code](https://github.com/icb08/clsproperties)**
+- **[Issues](https://github.com/icb08/clsproperties/issues)**
+- **[Documentation](https://github.com/icb08/clsproperties/wiki/Documentation)**
+- **[Changelog](https://github.com/icb08/clsproperties/wiki/Changelog)**
+- **[License](https://github.com/icb08/clsproperties/blob/main/LICENSE)**

clsproperties-1.0.0/README.md

@@ -0,0 +1,14 @@
+# clsproperties
+- **Author:** [Isaac Bell](https://github.com/icb08)
+- **Version:** [1.0.0](https://github.com/icb08/clsproperties/wiki/Changelog#1-0-0)
+
+This library provides `classproperty` objects for controlled access to class attributes.
+
+The `classproperty` class aims to emulate the behaviours of Python's built-in `property` class, providing controlled access to class attributes instead of instance attributes. Like `property` objects, `classproperty` objects support use both as a decorator and as a callable. Like `property` objects, `classproperty` objects are descriptors, supporting getter, setter and deleter functions. 
+
+## Links
+- **[Source Code](https://github.com/icb08/clsproperties)**
+- **[Issues](https://github.com/icb08/clsproperties/issues)**
+- **[Documentation](https://github.com/icb08/clsproperties/wiki/Documentation)**
+- **[Changelog](https://github.com/icb08/clsproperties/wiki/Changelog)**
+- **[License](https://github.com/icb08/clsproperties/blob/main/LICENSE)**

clsproperties-1.0.0/clsproperties/__init__.py

@@ -0,0 +1,185 @@
+"""
+# clsproperties
+- **Author:** [Isaac Bell](https://github.com/icb08)
+- **Version:** [1.0.0](https://github.com/icb08/clsproperties/wiki/Changelog#1-0-0)
+
+This library provides `classproperty` objects for controlled access to class attributes.
+
+The `classproperty` class aims to emulate the behaviours of Python's built-in `property` class, providing controlled access to class attributes instead of instance attributes. Like `property` objects, `classproperty` objects support use both as a decorator and as a callable. Like `property` objects, `classproperty` objects are descriptors, supporting getter, setter and deleter functions. 
+
+## Links
+- **[Source Code](https://github.com/icb08/clsproperties)**
+- **[Issues](https://github.com/icb08/clsproperties/issues)**
+- **[Documentation](https://github.com/icb08/clsproperties/wiki/Documentation)**
+- **[Changelog](https://github.com/icb08/clsproperties/wiki/Changelog)**
+- **[License](https://github.com/icb08/clsproperties/blob/main/LICENSE)**
+"""
+
+__author__ = "Isaac Bell"
+__version__ = "1.0.0"
+__all__ = ["classproperty","ClassPropertyMeta"]
+
+class classproperty:
+    """
+    Class property object.
+
+    This class defines a `classproperty` descriptor, supporting getter, setter and deleter functions, that aims to emulate the behaviours of Python's built-in `property` class, providing controlled access to class attributes instead of instance attributes. Like `property` objects, `classproperty` objects support use both as a decorator and as a callable.
+
+    For detailed information on usage and implementation, view the [Documentation](https://github.com/icb08/clsproperties/wiki/Documentation).
+
+    ---
+
+    ## Attributes / Properties
+    - **fget** (attribute) : *function*
+    > The getter function of the `classproperty` object.
+    - **fset** (attribute) : *function*
+    > The setter function of the `classproperty` object.
+    - **fdel** (attribute) : *function*
+    > The deleter function of the `classproperty` object.
+
+    ---
+
+    ## Methods / Functions
+    - **getter** (instance method)
+    > Define the getter function of the `classproperty` object.
+    - **setter** (instance method)
+    > Define the setter function of the `classproperty` object.
+    - **deleter** (instance method)
+    > Define the deleter function of the `classproperty` object.
+    """
+
+    def __init__(self,fget=None,fset=None,fdel=None,doc=None):
+        """
+        Instantiate a `classproperty` object.
+
+        This method instantiates a `classproperty` descriptor, defining the getter, setter and deleter functions.
+
+        For detailed information on usage and implementation, view the [Documentation](https://github.com/icb08/clsproperties/wiki/Documentation).
+        
+        ---
+
+        ## Parameters / Arguments
+        - **fget** (optional) : *function* (default=None)
+        > The getter function of the `classproperty` object.
+        - **fset** (optional) : *function* (default=None)
+        > The setter function of the `classproperty` object.
+        - **fdel** (optional) : *function* (default=None)
+        > The deleter function of the `classproperty` object.
+        - **doc** (optional) : *str* (default=None)
+        > Optional docstring for the `classproperty` object.
+        """
+        self.fget = fget
+        self.fset = fset
+        self.fdel = fdel
+        self.__doc__ = doc or (fget.__doc__ if fget else None)
+
+    def __set_name__(self,cls,name):
+        self.__name__ = name
+    
+    def __get__(self,instance,cls=None):
+        if cls is None: cls = type(instance)
+        if self.fget is None: raise AttributeError(f"Class property '{self.__name__}' of '{cls.__name__}' object has no getter.")
+        return self.fget(cls)
+    
+    def __set__(self,instance,value):
+        cls = type(instance)
+        if self.fset is None: raise AttributeError(f"Class property '{self.__name__}' of '{cls.__name__}' object has no setter.")
+        return self.fset(cls,value)
+    
+    def __delete__(self,instance):
+        cls = type(instance)
+        if self.fdel is None: raise AttributeError(f"Class property '{self.__name__}' of '{cls.__name__}' object has no deleter.")
+        return self.fdel(cls)
+    
+    def getter(self,fget):
+        """
+        Define the getter function of the `classproperty` object.
+
+        This method, typically used as a decorator, defines the getter function of the `classproperty` descriptor.
+
+        ---
+
+        ## Parameters / Arguments
+        - **fget** : *function*
+        > The getter function of the `classproperty` object.
+
+        ---
+
+        ## Returns
+        - *`classproperty` object*
+        > Returns a new `classproperty` object, with the specified getter function.
+        """
+        return type(self)(fget,self.fset,self.fdel,self.__doc__)
+    
+    def setter(self,fset):
+        """
+        Define the setter function of the `classproperty` object.
+
+        This method, typically used as a decorator, defines the setter function of the `classproperty` descriptor.
+
+        ---
+
+        ## Parameters / Arguments
+        - **fset** : *function*
+        > The setter function of the `classproperty` object.
+
+        ---
+
+        ## Returns
+        - *`classproperty` object*
+        > Returns a new `classproperty` object, with the specified setter function.
+        """
+        return type(self)(self.fget,fset,self.fdel,self.__doc__)
+    
+    def deleter(self,fdel):
+        """
+        Define the deleter function of the `classproperty` object.
+
+        This method, typically used as a decorator, defines the deleter function of the `classproperty` descriptor.
+
+        ---
+
+        ## Parameters / Arguments
+        - **fdel** : *function*
+        > The deleter function of the `classproperty` object.
+
+        ---
+
+        ## Returns
+        - *`classproperty` object*
+        > Returns a new `classproperty` object, with the specified deleter function.
+        """
+        return type(self)(self.fget,self.fset,fdel,self.__doc__)
+    
+class ClassPropertyMeta(type):
+    """
+    Class property metaclass.
+
+    This class defines a metaclass, that enables full functionality of `classproperty` objects defined in classes, whose metaclass is `ClassPropertyMeta`. This metaclass intercepts class attribute assignment and deletion operations of `classproperty` objects, and executes the corresponding setter and deleter functions of the `classproperty` objects.
+    
+    For detailed information on usage and implementation, view the [Documentation](https://github.com/icb08/clsproperties/wiki/Documentation).
+
+    ---
+
+    ## Attributes / Properties
+    N/A
+
+    ---
+
+    ## Methods / Functions
+    N/A
+    """
+
+    def __setattr__(cls,name,value):
+        attr = cls.__dict__.get(name)
+        if isinstance(attr,classproperty):
+            if attr.fset is None: raise AttributeError(f"Class property '{name}' of '{cls}' object has no setter.")
+            return attr.fset(cls,value)
+        super().__setattr__(name,value)
+    
+    def __delattr__(cls, name):
+        attr = cls.__dict__.get(name)
+        if isinstance(attr,classproperty):
+            if attr.fdel is None: raise AttributeError(f"Class property '{name}' of '{cls}' object has no deleter.")
+            return attr.fdel(cls)
+        super().__delattr__(name)

clsproperties-1.0.0/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "clsproperties"
+authors = [ { name = "Isaac Bell" } ]
+dynamic = ["version"]
+description = "Provides classproperty objects for controlled access to class attributes."
+readme = "README.md"
+requires-python = ">=3.6"
+license = "MIT"
+license-files = [ "LICENSE.txt" ]
+
+keywords = [
+    "python",
+    "python3",
+    "python-3",
+    "python-library",
+    "python-package",
+    "python-module",
+    "pypi",
+    "class",
+    "metaclass",
+    "attribute",
+    "attributes",
+    "classattribute",
+    "classattributes",
+    "property",
+    "properties",
+    "classproperty",
+    "classproperties",
+    "descriptor",
+    "getter",
+    "setter",
+    "deleter",
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Source = "https://github.com/icb08/clsproperties"
+Issues = "https://github.com/icb08/clsproperties/issues"
+Documentation = "https://github.com/icb08/clsproperties/wiki/Documentation"
+Changelog = "https://github.com/icb08/clsproperties/wiki/Changelog"
+License = "https://github.com/icb08/clsproperties/blob/main/LICENSE"
+
+[tool.hatch.version]
+path = "clsproperties/__init__.py"