Coder Social home page Coder Social logo

Comments (3)

ixje avatar ixje commented on June 7, 2024 1

I agree with your analysis. Most important for me was realizing that a value must be assigned before __init__ for it to be labelled as class-attribute

from griffe.

pawamoy avatar pawamoy commented on June 7, 2024

From a user point of view, myclass_attribute is accessible both from the class (MyClass.myclass_attribute) and the instances (myclass.myclass_attribute), so it should have both class and instance labels (not sure why it does not get the class one, I'll check). If you want the attribute to only have the class label, you can use typing.ClassVar:

from typing import ClassVar

class MyClass:
    myclass_attribute: ClassVar[float]

from griffe.

pawamoy avatar pawamoy commented on June 7, 2024

OK, so IMO it makes sense:

  • if your class attribute does not have a value (only an annotation), users cannot access it at runtime on the class, so no class-attribute label
  • however, Griffe expects that its value will be set in the __init__ method (either explicitly or thanks to dataclasses for example), therefore it sets the instance-attribute label.
  • finally, a class attribute with a value will also always be accessible on instances, so class attributes with values always get an instance-attribute label

Let me know what you think. In the meantime I'll close this issue as I think the behavior is correct as it is.

from griffe.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.