Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

a2435191/python-attribute-access-modifiers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

10 Commits

Repository files navigation

python-attribute-access-modifiers

Tired of typing @property just to make a read-only instance variable? Find yourself wishing for C#'s {get; set;} syntax? Look no further than PAAM, which auto-generates property getters, setter, and deleters for you!

Quickstart

Once installed, just use the overloaded | operator between an instance variable and one of the predefined constants GET, SET, or DEL. Make sure to subclass from PaamBase.

from paam import SET, PaamBase
class Test(PaamBase):
 def __init__(self, a: int):
 self.a = a | GET # write to self.a (not self._a) because PAAM creates setters/getters/deleters *after* __init__ finishes
>>> obj = Test(15)
>>> obj.a
>>> 15
>>> obj.a = 5 # raises AttributeError: can't set attribute

Property access modifiers can also be chained (order doesn't matter):

from paam import SET, GET, DEL, PaamBase
class Test(PaamBase):
 def __init__(self, a: int):
 self.a = a | GET | SET
>>> obj = Test(15)
>>> obj.a
>>> 15
>>> obj.a = 5
>>> obj.a
>>> 5
>>> del obj.a # raises AttributeError: can't delete attribute

Caveats (all planned to be fixed in future release)

  • The type of any variable "annotated" with GET, SET, or DEL is _PropertyAccessModifierBase. This means mypy support and IDE type hinting are most likely broken.
  • No tests
  • Error messages currently only show owner class

About

Add C#-like `{get; set;}` syntax to Python attributes.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

AltStyle によって変換されたページ (->オリジナル) /