GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - mkdocstrings/griffe-runtime-objects: Make runtime objects available through `extra`.

BranchesTags
Open more actions menu

Latest commit

 

History

27 Commits
27 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
config
config
 
 
docs
docs
 
 
scripts
scripts
 
 
src/griffe_runtime_objects
src/griffe_runtime_objects
 
 
tests
tests
 
 
.copier-answers.yml
.copier-answers.yml
 
 
.envrc
.envrc
 
 
.gitignore
.gitignore
 
 
AI_POLICY.md
AI_POLICY.md
 
 
CHANGELOG.md
CHANGELOG.md
 
 
CODE_OF_CONDUCT.md
CODE_OF_CONDUCT.md
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
duties.py
duties.py
 
 
pyproject.toml
pyproject.toml
 
 
zensical.toml
zensical.toml
 
 

Repository files navigation

griffe-runtime-objects

ci documentation pypi version gitter

Make runtime objects available through extra.

Installation

pip install griffe-runtime-objects

Usage

Enable the griffe_runtime_objects extension. Now all Griffe objects will have access to the corresponding runtime objects in their extra attribute, under the runtime-objects namespace:

>>> import griffe
>>> griffe_data = griffe.load("griffe", extensions=griffe.load_extensions("griffe_runtime_objects"), resolve_aliases=True)
>>> griffe_data["parse"].extra
defaultdict(<class 'dict'>, {'runtime-objects': {'object': <function parse at 0x78685c951260>}})
>>> griffe_data["Module"].extra
defaultdict(<class 'dict'>, {'runtime-objects': {'object': <class '_griffe.models.Module'>}})

This extension can be useful in custom templates of mkdocstrings-python, to iterate on an object value or attributes.

With MkDocs:

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_runtime_objects

Sponsors

Bronze sponsors

Nixtla


ofek samuelcolvin tlambert03 ssbarnea femtomc FastAPI cmarqu kolenaIO ramnes machow BenHammersley trevorWieland MarcoGorelli analog-cbarber OdinManiac rstudio-sponsorship schlich butterlyn livingbio NemetschekAllplan EricJayHartman 15r10nk activeloopai roboflow RapidataAI rodolphebarbanneau theSymbolSyndicate blakeNaccarato ChargeStorm Cusp-AI

And 4 more private sponsor(s).

About

Make runtime objects available through `extra`.

mkdocstrings.github.io/griffe-runtime-objects/

Topics

griffegriffe-extension

Resources

Readme
ISC license

Code of conduct

Code of conduct

Contributing

Contributing
Activity
Custom properties

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases

Sponsor this project

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.