Coder Social home page Coder Social logo

Comments (4)

gpuligundla avatar gpuligundla commented on June 7, 2024

Hi, could you please describe more about the bug, with current behaviour and expected behaviour

from griffe.

pawamoy avatar pawamoy commented on June 7, 2024

Sure, sorry for the low quality report 😅

For example with:

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from thing import stuff

If you remove the import under the type checking condition, Griffe will report that stuff was removed from the module.

But this is wrong: stuff was never available at runtime, and therefore should not be reported.

Griffe already detects such "type-guarded" objects, and sets runtime=False on them. We could use this runtime attribute to prevent reporting their removal.

from griffe.

gpuligundla avatar gpuligundla commented on June 7, 2024

Hi @pawamoy, I guess the current version of griffe doesn't report this error. I tried to test it by passing it to find_breaking_changes(). it checks the runtime and ignores reporting.

or am I in the wrong direction?
help me to understand it

from griffe.

pawamoy avatar pawamoy commented on June 7, 2024

Well, it seems I cannot reproduce the issue described here 🤔 I noticed a few times typing-related objects being reported, and I suppose I wrongly thought they were type-guarded while they were not 🤔 Sorry that you wasted time on this 🙇 Lets close. I'll reopen if I find a reproducible example.

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.