Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extract attribute docstrings for FieldInfo.description #6563

Merged
merged 38 commits into from Jan 25, 2024
Merged

Extract attribute docstrings for FieldInfo.description #6563

merged 38 commits into from Jan 25, 2024
+521 −7

Commits on Jul 9, 2023

  1. WIP: Implement docs extraction

    @Viicos
    Viicos committed Jul 9, 2023
    Configuration menu
    Copy the full SHA
    29bbf3e View commit details
    Browse the repository at this point in the history

Commits on Jul 10, 2023

  1. Implement attribute docstring extractiob

    @Viicos
    Viicos committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    792da19 View commit details
    Browse the repository at this point in the history

Commits on Jul 12, 2023

  1. Apply feedback

    @Viicos
    Viicos committed Jul 12, 2023
    Configuration menu
    Copy the full SHA
    d3e8402 View commit details
    Browse the repository at this point in the history

  2. Implement ast.NodeVisitor

    @Viicos
    Viicos committed Jul 12, 2023
    Configuration menu
    Copy the full SHA
    c9325d7 View commit details
    Browse the repository at this point in the history

  3. Add use_attributes_docstring config value

    @Viicos
    Viicos committed Jul 12, 2023
    Configuration menu
    Copy the full SHA
    1f81724 View commit details
    Browse the repository at this point in the history

  4. WIP: First tests

    @Viicos
    Viicos committed Jul 12, 2023
    Configuration menu
    Copy the full SHA
    cab7a07 View commit details
    Browse the repository at this point in the history

Commits on Jul 13, 2023

  1. Fix tests to cope with inspect.getsource

    @Viicos
    Viicos committed Jul 13, 2023
    Configuration menu
    Copy the full SHA
    e46890c View commit details
    Browse the repository at this point in the history

Commits on Sep 20, 2023

  1. Add config docstring

    @Viicos
    Viicos committed Sep 20, 2023
    Configuration menu
    Copy the full SHA
    af4f340 View commit details
    Browse the repository at this point in the history

  2. Support TypedDict

    @Viicos
    Viicos committed Sep 20, 2023
    Configuration menu
    Copy the full SHA
    d3a4761 View commit details
    Browse the repository at this point in the history

Commits on Oct 22, 2023

  1. Walk back frames to get source code

    @Viicos
    Viicos committed Oct 22, 2023
    Configuration menu
    Copy the full SHA
    3da7402 View commit details
    Browse the repository at this point in the history

  2. Handle the case where f_lineno is not an int

    @Viicos
    Viicos committed Oct 22, 2023
    Configuration menu
    Copy the full SHA
    4f73618 View commit details
    Browse the repository at this point in the history

Commits on Oct 23, 2023

  1. Fix usage of getblock

    @Viicos
    Viicos committed Oct 23, 2023
    Configuration menu
    Copy the full SHA
    2102756 View commit details
    Browse the repository at this point in the history

  2. Improve class detection when walking up frames 

    Still needs additional tests, I think we can hit edge cases where
detection still doesn't work as expected.
By checking if we find the `class` statement when walking up frames,
we are able to make it work with dataclasses/TypedDicts.
Using a regexp match was required, or it would lead to false positives,
and we can't just use startswith as there can be an arbitrary number of
spaces between `class` and the name of that class.
    @Viicos
    Viicos committed Oct 23, 2023
    Configuration menu
    Copy the full SHA
    8ae16c0 View commit details
    Browse the repository at this point in the history

  3. Apply feedback and last fixes

    @Viicos
    Viicos committed Oct 23, 2023
    Configuration menu
    Copy the full SHA
    436e95a View commit details
    Browse the repository at this point in the history

  4. Add test with create_model

    @Viicos
    Viicos committed Oct 23, 2023
    Configuration menu
    Copy the full SHA
    85e4c0f View commit details
    Browse the repository at this point in the history

Commits on Oct 24, 2023

  1. WIP: Feedback and additional tests

    @Viicos
    Viicos committed Oct 24, 2023
    Configuration menu
    Copy the full SHA
    d8cbc3b View commit details
    Browse the repository at this point in the history

  2. More tests and small code refactors 

    Co-authored-by: Alex Hall <alex.mojaki@gmail.com>
    @Viicos @alexmojaki
    Viicos and alexmojaki committed Oct 24, 2023
    Configuration menu
    Copy the full SHA
    f8c56a9 View commit details
    Browse the repository at this point in the history

  3. Use same model names in tests 

    Almost there, still need to see which lines to use when walking up
stack frame

Co-authored-by: Alex Hall <alex.mojaki@gmail.com>
    @Viicos @alexmojaki
    Viicos and alexmojaki committed Oct 24, 2023
    Configuration menu
    Copy the full SHA
    44a4a73 View commit details
    Browse the repository at this point in the history

  4. Fix rebase

    @Viicos
    Viicos committed Oct 24, 2023
    Configuration menu
    Copy the full SHA
    43c1c82 View commit details
    Browse the repository at this point in the history

Commits on Oct 25, 2023

  1. Use source lines from frame object

    @Viicos
    Viicos committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    626a19a View commit details
    Browse the repository at this point in the history

  2. Improve config docstring, apply additional feedback, fix infinite loop 

    Co-authored-by: Alex Hall <alex.mojaki@gmail.com>
    @Viicos @alexmojaki
    Viicos and alexmojaki committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    359846b View commit details
    Browse the repository at this point in the history

  3. pyright

    @Viicos
    Viicos committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    c12f020 View commit details
    Browse the repository at this point in the history

  4. lint again

    @Viicos
    Viicos committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    b9ca191 View commit details
    Browse the repository at this point in the history

  5. Remove unrelated file

    @Viicos
    Viicos committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    05598d3 View commit details
    Browse the repository at this point in the history

  6. Fix handling of dataclasses with Python>=3.11

    @Viicos
    Viicos committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    a044bce View commit details
    Browse the repository at this point in the history

  7. Fix return value

    @Viicos
    Viicos committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    23c8695 View commit details
    Browse the repository at this point in the history

Commits on Oct 26, 2023

  1. Parse the frame block using ast

    @Viicos
    Viicos committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    70b5ec2 View commit details
    Browse the repository at this point in the history

  2. Dedent fix

    @Viicos
    Viicos committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    7d9d77a View commit details
    Browse the repository at this point in the history

  3. Some optimizations

    @Viicos
    Viicos committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    0f1743b View commit details
    Browse the repository at this point in the history

  4. Comments reordering

    @Viicos
    Viicos committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    ab3dfc0 View commit details
    Browse the repository at this point in the history

Commits on Oct 27, 2023

  1. Remove commented breakpoint()

    @Viicos
    Viicos committed Oct 27, 2023
    Configuration menu
    Copy the full SHA
    d451205 View commit details
    Browse the repository at this point in the history

  2. Add additional generic assertion

    @Viicos
    Viicos committed Oct 27, 2023
    Configuration menu
    Copy the full SHA
    146f915 View commit details
    Browse the repository at this point in the history

  3. Fix failing test

    @Viicos
    Viicos committed Oct 27, 2023
    Configuration menu
    Copy the full SHA
    23396b8 View commit details
    Browse the repository at this point in the history

Commits on Oct 28, 2023

  1. Apply minor changes and fixes

    @Viicos
    Viicos committed Oct 28, 2023
    Configuration menu
    Copy the full SHA
    73f1a94 View commit details
    Browse the repository at this point in the history

Commits on Nov 10, 2023

  1. Update to latest pyright

    @Viicos
    Viicos committed Nov 10, 2023
    Configuration menu
    Copy the full SHA
    f3e84a6 View commit details
    Browse the repository at this point in the history

Commits on Nov 15, 2023

  1. fix rebase

    @Viicos
    Viicos committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    d9150c6 View commit details
    Browse the repository at this point in the history

  2. Use latest pyright

    @Viicos
    Viicos committed Nov 15, 2023
    Configuration menu
    Copy the full SHA
    abba7d2 View commit details
    Browse the repository at this point in the history

Commits on Jan 13, 2024

  1. Merge branch 'main' into docstrings-description

    @Viicos
    Viicos committed Jan 13, 2024
    Configuration menu
    Copy the full SHA
    caa5cbe View commit details
    Browse the repository at this point in the history