Metadata-Version: 2.1
Name: access-modifiers
Version: 0.1.4
Summary: Private and protected access modifiers for Python
Home-page: https://github.com/fniessink/access-modifiers
Author: Frank Niessink
Author-email: frank@niessink.com
License: Apache 2.0
Description: # Access modifiers for Python
        
        [![Build Status](https://travis-ci.com/fniessink/access-modifiers.svg?branch=master)](https://travis-ci.com/fniessink/access-modifiers)
        [![PyPI](https://img.shields.io/pypi/v/access-modifiers.svg)](https://pypi.python.org/pypi/access-modifiers)
        
        This package provides two access modifiers for Python: private methods and protected methods. The goal is to be able to document methods as being private or protected and to provide basic guards against accidentally calling private and protected methods from outside the allowed scopes.
        
        ## Example usage
        
        Example usage of private methods:
        
        ```python
        from access_modifiers import privatemethod
        
        class Class:
            @privatemethod
            def private_method(self) -> str:
                """A private method."""
                return "private method"
        
            def public_method(self) -> str:
                return "public method calls " + self.private_method()
        
        c = Class()
        print(c.public_method())  # Prints "public method calls private method"
        print(c.private_method())  # Raises an exception
        ```
        
        Example usage of protected methods:
        
        ```python
        from access_modifiers import protectedmethod
        
        class Class:
            @protectedmethod
            def protected_method(self) -> str:
                """A protected method."""
                return "protected method"
        
            def public_method(self) -> str:
                return "public method calls " + self.protected_method()
        
        
        class Subclass(Class):
            @protectedmethod
            def protected_method(self) -> str:
                """An overridden protected method."""
                return "overridden protected method calls " + super().protected_method()
        
        c = Subclass()
        print(c.public_method())  # Prints "public method calls overridden protected method calls protected method"
        print(c.protected_method())  # Raises an exception
        ```
        
        ## Installation
        
        The package is available from the Python Package Index, install with `pip install access-modifiers`.
        
        ## Development 
        
        To clone the repository: `git clone git@github.com:fniessink/access-modifiers.git`.
        
        To install the development dependencies: `pip install -r requirements-dev.txt`.
        
        To run the unittests and measure the coverage (which should always be at 100%): `ci/unittest.sh`.
        
        To run Pylint (which should score a 10) and Mypy (which shouldn't complain): `ci/quality.sh`.
        
        ## Implementation notes
        
        Both the `privatemethod` and the `protectedmethod` decorator work by looking at the code that is calling the decorator to decide whether it is allowed to call the method. Please look at the tests to see which scenario's are currently covered.
        
        Unsupported/untested are nested decorators, e.g.: 
        
        ```python
        class Class:
            @privatemethod
            @staticmethod
            def private_static_method():
                return "a private static method"  # This is unsupported and untested!
        ```
        
Keywords: access modifier,protected,private,oop
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
