advanced-descriptors

Advanced descriptors for special cases.

These details have not been verified by PyPI

Project links

Project description

Advanced descriptors

https://coveralls.io/repos/github/python-useful-helpers/advanced-descriptors/badge.svg?branch=master

https://img.shields.io/pypi/v/advanced-descriptors.svg

https://img.shields.io/pypi/pyversions/advanced-descriptors.svg

https://img.shields.io/pypi/status/advanced-descriptors.svg

https://img.shields.io/github/license/python-useful-helpers/advanced-descriptors.svg

https://img.shields.io/badge/code%20style-black-000000.svg

This package includes helpers for special cases:

SeparateClassMethod - allow to have classmethod and normal method both with the same name.
AdvancedProperty - property with possibility to set class wide getter.
LogOnAccess - property with logging on successful get/set/delete or failure.

SeparateClassMethod

This descriptor can be set using standard decorator syntax. Create instance with arguments:

def imeth(instance):
    return instance.value

def cmeth(owner):
    return owner.value

class Target(object):
    value = 1

    def __init__(self):
        self.value = 2
    getval = advanced_descriptors.SeparateClassMethod(
        imeth, cmeth
    )

Create instance wrapping as decorator:

class Target(object):
    value = 1

    def __init__(self):
        self.value = 2

    @advanced_descriptors.SeparateClassMethod
    def getval(self):
        return self.value

    @getval.class_method
    def getval(cls):
        return cls.value

Cases with method only and classmethod only is useless: method as-is and @classmethod should be used in corresponding cases.

AdvancedProperty

This descriptor should be used in cases, when in addition to normal property API, class getter is required. If class-wide setter and deleter also required - you should use standard propery in metaclass.

Usage examples:

In addition to normal property API:

class Target(object):
    _value = 777

    def __init__(self):
        self._value = 42

    @advanced_descriptors.AdvancedProperty
    def val(self):
        return self._value

    @val.setter
    def val(self, value):
        self._value = value

    @val.deleter
    def val(self):
        self._value = 0

    @val.cgetter
    def val(cls):
        return cls._value

Use class-wide getter for instance too:

class Target(object):
    _value = 1

    val = advanced_descriptors.AdvancedProperty()

    @val.cgetter
        def val(cls):
            return cls._value

LogOnAccess

This special case of property is useful in cases, where a lot of properties should be logged by similar way without writing a lot of code.

Basic API is conform with property, but in addition it is possible to customize logger, log levels and log conditions.

Usage examples:

Simple usage. All by default. logger is re-used from instance if available with names logger or log else used internal advanced_descriptors.log_on_access logger:

import logging

class Target(object):

    def init(self, val='ok')
        self.val = val
        self.logger = logging.get_logger(self.__class__.__name__)  # Single for class, follow subclassing

    def __repr__(self):
        return "{cls}(val={self.val})".format(cls=self.__class__.__name__, self=self)

    @advanced_descriptors.LogOnAccess
    def ok(self):
        return self.val

    @ok.setter
    def ok(self, val):
        self.val = val

    @ok.deleter
    def ok(self):
        self.val = ""

Use with global logger for class:

class Target(object):

  def init(self, val='ok')
      self.val = val

  def __repr__(self):
      return "{cls}(val={self.val})".format(cls=self.__class__.__name__, self=self)

  @advanced_descriptors.LogOnAccess
  def ok(self):
      return self.val

  @ok.setter
  def ok(self, val):
      self.val = val

  @ok.deleter
  def ok(self):
      self.val = ""

  ok.logger = 'test_logger'
  ok.log_level = logging.INFO
  ok.exc_level = logging.ERROR
  ok.log_object_repr = True  # As by default
  ok.log_success = True  # As by default
  ok.log_failure = True  # As by default
  ok.log_traceback = True  # As by default
  ok.override_name = None  # As by default: use original name

Testing

The main test mechanism for the package advanced-descriptors is using tox. Available environments can be collected via tox -l

CI systems

For code checking several CI systems is used in parallel:

Travis CI: is used for checking: PEP8, pylint, bandit, installation possibility and unit tests. Also it’s publishes coverage on coveralls.
coveralls: is used for coverage display.
Azure CI: is used for functional tests on Windows.

CD system

Travis CI: is used for package delivery on PyPI.

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

4.0.3

Dec 16, 2022

4.0.2

Nov 2, 2021

4.0.1

Jul 1, 2021

4.0.0

Jul 1, 2021

This version

3.0.9.post0

Nov 16, 2020

3.0.9

Nov 16, 2020

3.0.8

Feb 11, 2020

3.0.7

Feb 6, 2020

3.0.6

Oct 29, 2019

3.0.5

Oct 16, 2019

3.0.4

Oct 16, 2019

3.0.3

Apr 29, 2019

3.0.2

Apr 16, 2019

3.0.1

Feb 18, 2019

3.0.0

Dec 27, 2018

2.2.8

Apr 29, 2019

2.2.7

Feb 18, 2019

2.2.6

Feb 18, 2019

2.2.5

Jan 2, 2019

2.2.4

Dec 5, 2018

2.2.3

Nov 21, 2018

2.2.2

Nov 21, 2018

2.2.1

Oct 16, 2018

2.2.0

Oct 16, 2018

2.1.0

Oct 3, 2018

2.0.0

Oct 1, 2018

1.1.2

Apr 29, 2019

1.1.1

Feb 18, 2019

1.1.0

Jan 28, 2019

1.0.7

Oct 1, 2018

1.0.6

Sep 21, 2018

1.0.5

Aug 15, 2018

1.0.4

Jul 3, 2018

1.0.3

Jun 8, 2018

1.0.2

May 24, 2018

1.0.1

May 15, 2018

1.0.0

May 1, 2018

0.6.0

Mar 23, 2018

0.5.6

Mar 21, 2018

0.5.5

Mar 21, 2018

0.5.4

Mar 2, 2018

0.5.3

Mar 1, 2018

0.5.2

Dec 1, 2017

0.5.1

Dec 1, 2017

0.5.0

Dec 1, 2017

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

advanced-descriptors-3.0.9.post0.tar.gz (28.8 kB view details)

Uploaded Nov 16, 2020 Source

Built Distributions

advanced_descriptors-3.0.9.post0-py3-none-any.whl (16.6 kB view details)

Uploaded Nov 16, 2020 Python 3

advanced_descriptors-3.0.9.post0-cp39-cp39-win_amd64.whl (135.0 kB view details)

Uploaded Nov 16, 2020 CPython 3.9 Windows x86-64

advanced_descriptors-3.0.9.post0-cp39-cp39-win32.whl (120.4 kB view details)

Uploaded Nov 16, 2020 CPython 3.9 Windows x86

advanced_descriptors-3.0.9.post0-cp39-cp39-manylinux2014_x86_64.whl (622.4 kB view details)

Uploaded Nov 16, 2020 CPython 3.9

advanced_descriptors-3.0.9.post0-cp39-cp39-manylinux2014_i686.whl (593.2 kB view details)

Uploaded Nov 16, 2020 CPython 3.9

advanced_descriptors-3.0.9.post0-cp39-cp39-manylinux2014_aarch64.whl (617.3 kB view details)

Uploaded Nov 16, 2020 CPython 3.9

advanced_descriptors-3.0.9.post0-cp39-cp39-manylinux2010_x86_64.whl (591.9 kB view details)

Uploaded Nov 16, 2020 CPython 3.9 manylinux: glibc 2.12+ x86-64

advanced_descriptors-3.0.9.post0-cp39-cp39-manylinux2010_i686.whl (562.6 kB view details)

Uploaded Nov 16, 2020 CPython 3.9 manylinux: glibc 2.12+ i686

advanced_descriptors-3.0.9.post0-cp39-cp39-manylinux1_x86_64.whl (591.9 kB view details)

Uploaded Nov 16, 2020 CPython 3.9

advanced_descriptors-3.0.9.post0-cp39-cp39-manylinux1_i686.whl (593.2 kB view details)

Uploaded Nov 16, 2020 CPython 3.9

advanced_descriptors-3.0.9.post0-cp38-cp38-win_amd64.whl (136.1 kB view details)

Uploaded Nov 16, 2020 CPython 3.8 Windows x86-64

advanced_descriptors-3.0.9.post0-cp38-cp38-win32.whl (121.8 kB view details)

Uploaded Nov 16, 2020 CPython 3.8 Windows x86

advanced_descriptors-3.0.9.post0-cp38-cp38-manylinux2014_x86_64.whl (708.1 kB view details)