https://github.com/jonghwanhyeon/griffe-modernized-annotations

A Griffe extension that modernizes type annotations by adopting PEP 585 and PEP 604
https://github.com/jonghwanhyeon/griffe-modernized-annotations

annotations griffe griffe-extension

Last synced: about 2 months ago
JSON representation

A Griffe extension that modernizes type annotations by adopting PEP 585 and PEP 604

• Host: GitHub
• URL: https://github.com/jonghwanhyeon/griffe-modernized-annotations
• Owner: jonghwanhyeon
• License: mit
• Created: 2024-07-28T15:49:01.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-16T10:01:31.000Z (5 months ago)
• Last Synced: 2024-09-17T10:29:42.415Z (4 months ago)
• Topics: annotations, griffe, griffe-extension
• Language: Python
• Homepage:
• Size: 153 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# griffe-modernized-annotations

![Build status](https://github.com/jonghwanhyeon/griffe-modernized-annotations/actions/workflows/publish.yml/badge.svg)

A Griffe extension that modernizes type annotations by adopting PEP 585 and PEP 604

## Example

Without extension:

![Without Extension](https://github.com/jonghwanhyeon/griffe-modernized-annotations/raw/main/assets/without-extension.png)

With extension:

![With Extension](https://github.com/jonghwanhyeon/griffe-modernized-annotations/raw/main/assets/with-extension.png)

## Install

To install **griffe-modernized-annotations**, simply use pip:

```console

$ pip install griffe-modernized-annotations

```

## Usage

```yaml

plugins:

  - mkdocstrings:

      handlers:

        python:

          options:

            extensions:

              - griffe_modernized_annotations

```