Comments (3)
tristanlatr
commented on August 25, 2024
This is how I check for the TYPE checking blocks: https://github.com/tristanlatr/pydocspec/blob/main/pydocspec/astroidutils.py#L359-L374
Objects have a field is_type_guarded wich is set to True is the context is under a type guard if condition.
Then the wildcard import rely on __all__ or the public names returnde with this function: https://github.com/tristanlatr/pydocspec/blob/main/pydocspec/processor/mod_attr.py#L75-L87
from griffe.
pawamoy
commented on August 25, 2024
Thanks @tristanlatr! I was indeed thinking about adding a field on objects so that we know they are type-guarded or not.
from griffe.
pawamoy
commented on August 25, 2024
Released in 0.17.0!
from griffe.
Related Issues (20)
- refactor: Rework "exported" and "public" logic
- feature: Support conventions to mark objects as public HOT 2
- bug: attempting to load external non-module alias triggers .resolve_target() HOT 2
- feat: Generate `__init__` methods for typed dicts with `**kwargs: Unpack[MyDict]` to help docstring parser fetch other parameters types HOT 7
- Adopt a shared specification for api structure HOT 1
- feature: A way to get docstrings, ... of InitVar parameters of a dataclass HOT 2
- bug: Type is missing, and default value is incorrect for class variable in a dataclass HOT 4
- feature: allow plugins to extend json output HOT 3
- bug: Enum members mis-labelled as instance attributes HOT 3
- feature: I'd like to be able to use `Docstring` without requiring `parent` but get no warning HOT 8
- bug: mkdocstrings filters option doesn't work anymore after upgrade to griffe 0.46.0 HOT 18
- bug: [regression 0.46] Does not find inherited methods HOT 4
- bug: Wrong alias target path when inspecting class, causing stubs-merging to fail silently HOT 20
- bug: Yields broken for properties HOT 1
- feature: Improve recognition of functions through assignments
- bug: `.pth` files generated by PyTorch are incompatible with path configuration file handling HOT 3
- bug: RecursionError: maximum recursion depth exceeded HOT 14
- bug: Pydantic dataclasses with extra args break parsing of the function signature HOT 7
- backports.strenum dependency missing in conda package HOT 7
- feature: stable `as_json` HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from griffe.