https://github.com/enthought/traits

Observable typed attributes for Python classes
https://github.com/enthought/traits

attributes dataclasses gui observer-pattern python runtime-typechecking types

Last synced: 2 days ago
JSON representation

Observable typed attributes for Python classes

• Host: GitHub
• URL: https://github.com/enthought/traits
• Owner: enthought
• License: other
• Created: 2011-01-28T04:46:40.000Z (almost 14 years ago)
• Default Branch: main
• Last Pushed: 2024-05-26T19:02:44.000Z (7 months ago)
• Last Synced: 2024-05-29T18:33:49.894Z (7 months ago)
• Topics: attributes, dataclasses, gui, observer-pattern, python, runtime-typechecking, types
• Language: Python
• Homepage:
• Size: 52.3 MB
• Stars: 415
• Watchers: 66
• Forks: 85
• Open Issues: 226
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE-CC-BY-3.0.txt

Awesome Lists containing this project

README

        
======================================================

Traits: observable typed attributes for Python classes

======================================================

http://docs.enthought.com/traits

The Traits project is at the center of all Enthought Tool Suite development

and has changed the mental model used at Enthought for programming in the

already extremely efficient Python programming language. We encourage everyone

to join us in enjoying the productivity gains from using such a powerful

approach.

The Traits project allows Python programmers to use a special kind of type

definition called a *trait*, which gives object attributes some additional

characteristics:

- **Initialization**: A trait has a *default value*, which is

  automatically set as the initial value of an attribute before its

  first use in a program.

- **Validation**: The type of a trait attribute is *explicitly declared*. The

  type is evident in the code, and only values that meet a

  programmer-specified set of criteria (i.e., the trait definition) can

  be assigned to that attribute.

- **Delegation**: The value of a trait attribute can be contained either

  in the defining object or in another object *delegated* to by the

  trait.

- **Notification**: Setting the value of a trait attribute can *notify*

  other parts of the program that the value has changed.

- **Visualization**: User interfaces that allow a user to *interactively

  modify* the value of a trait attribute can be automatically

  constructed using the trait's definition. (This feature requires that

  a supported GUI toolkit be installed. If this feature is not used, the

  Traits project does not otherwise require GUI support.)

A class can freely mix trait-based attributes with normal Python attributes,

or can opt to allow the use of only a fixed or open set of trait attributes

within the class. Trait attributes defined by a class are automatically

inherited by any subclass derived from the class.

Dependencies

------------

Traits requires Python >= 3.8.

Traits has the following optional dependencies:

* `NumPy `_ to support the trait types

  for arrays.

* `TraitsUI `_ to support GUI

  Views.

To build the full documentation one needs:

* `Sphinx `_ version 2.1 or later.

* The `Enthought Sphinx Theme `_.

  (A version of the documentation can be built without this, but

  some formatting may be incorrect.)