First modification for pep237 with pydocstringformatter #1792

Pierre-Sassoulas · 2022-09-18T07:12:31Z

Description

Type of Changes

	Type
✓	📜 Docs

Related Issue

Some results are not correct, this is the occasion to make pydocstringformatter better and to add astroid to its primer. We will handle the incorrect one in #1796

coveralls · 2022-09-18T07:15:25Z

Pull Request Test Coverage Report for Build 3082403333

34 of 34 (100.0%) changed or added relevant lines in 23 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 92.424%

Totals
Change from base Build 3076284340:	0.0%
Covered Lines:	9796
Relevant Lines:	10599

💛 - Coveralls

astroid/brain/brain_boto3.py

astroid/brain/brain_collections.py

astroid/brain/brain_unittest.py

astroid/context.py

Pierre-Sassoulas · 2022-09-18T07:24:07Z

astroid/inference.py

@@ -971,7 +972,8 @@ def _do_compare(
 ) -> bool | type[util.Uninferable]:
    """
    If all possible combinations are either True or False, return that:
-    >>> _do_compare([1, 2], '<=', [3, 4])
+    >>> _do_compare([1, 2], '<=', [3, 4]).


It will be fixed in DanielNoord/pydocstringformatter#168

astroid/modutils.py

DanielNoord · 2022-09-18T10:11:13Z

@Pierre-Sassoulas Will you open issues about stuff that is broken?

Pierre-Sassoulas · 2022-09-18T12:03:32Z

Will you open issues about stuff that is broken?

Yes, if you think it's necessary : #1792 (comment) for example would be hard to fix imo ?

I think the only clear cut one would be : #1792 (comment) (only typing information without text)

DanielNoord · 2022-09-18T12:07:23Z

Yes, if you think it's necessary : #1792 (comment) for example would be hard to fix imo ?

DanielNoord/pydocstringformatter#127

I think the only clear cut one would be : #1792 (comment) (only typing information without text)

I think this can also be fixed. We just need to wrap>split>period instead of split>wrap>period.
Perhaps even wrap>split>wrap>period.

Something to investigate at least!

Pierre-Sassoulas · 2022-09-18T13:44:56Z

I created DanielNoord/pydocstringformatter#175

I think we can"t add pydocstringformatter right now, but we might want to integrate the change that make sense right now, what do you think ?

DanielNoord · 2022-09-18T19:35:21Z

I think we can"t add pydocstringformatter right now, but we might want to integrate the change that make sense right now, what do you think ?

Agreed! Is this reviewable?

Pierre-Sassoulas · 2022-09-18T20:19:12Z

Agreed! Is this reviewable?

Not yet, I'll clean this up in the coming week

Pierre-Sassoulas · 2022-09-19T12:33:38Z

This is reviewable now :)

DanielNoord · 2022-09-19T14:08:37Z

astroid/astroid_manager.py

@@ -1,5 +1,7 @@
 """
-This file contain the global astroid MANAGER, to prevent circular import that happened
+This file contain the global astroid MANAGER, to prevent circular import that
+happened.


This sentence is now broken.

I missed so much of those that I'll need to redo the commit entirely. I'll get to it. There's a lot of change to review.

DanielNoord · 2022-09-19T14:10:09Z

astroid/brain/brain_hypothesis.py

@@ -39,7 +38,8 @@ def is_decorated_with_st_composite(node):

 def remove_draw_parameter_from_composite_strategy(node):
    """Given that the FunctionDef is decorated with @st.composite, remove the
-    first argument (`draw`) - it's always supplied by Hypothesis so we don't
+    first argument (`draw`) - it's always supplied by Hypothesis so we don't.


This is broken.

DanielNoord · 2022-09-19T14:12:04Z

astroid/exceptions.py

-    """Raised when a call to node.statement() does not return a node. This is because
+    """Raised when a call to node.statement() does not return a node.
+
+    This is because


L406 should probably be appended here.

DanielNoord · 2022-09-19T14:13:13Z

astroid/manager.py

-possible by providing a class responsible to get astroid representation
+"""Astroid manager: avoid multiple astroid build of a same module when
+possible by providing a class responsible to get astroid representation.
+
 from various source and using a cache of built modules)


This is broken. Also note there is a single ) without a (

astroid/modutils.py

DanielNoord · 2022-09-19T14:14:23Z

astroid/nodes/as_string.py

        if self._should_wrap(node, child, is_left):
            return f"({child.accept(self)})"

        return child.accept(self)

    def _should_wrap(self, node, child, is_left):
        """Wrap child if:
-        - it has lower precedence
+        - it has lower precedence.


This should probably be done differently.

DanielNoord · 2022-09-19T14:14:55Z

astroid/nodes/node_classes.py

-"""Module for some node classes. More nodes in scoped_nodes.py"""
+"""Module for some node classes.
+
+More nodes in scoped_nodes.py


This is nog longer true. It is now a package.

DanielNoord · 2022-09-19T14:15:52Z

astroid/nodes/scoped_nodes/mixin.py

-    """this class provides locals handling common to Module, FunctionDef
-    and ClassDef nodes, including a dict like interface for direct access
+    """This class provides locals handling common to Module, FunctionDef
+    and ClassDef nodes, including a dict like interface for direct access.


This is broken.

DanielNoord · 2022-09-19T14:16:14Z

astroid/nodes/scoped_nodes/scoped_nodes.py

@@ -691,6 +692,7 @@ def __init__(
    ):
        """
        :param lineno: The line that this node appears on in the source code.
+


I think this breaks valid Sphinx documentation

DanielNoord · 2022-09-19T14:16:54Z

astroid/raw_building.py

-        """build astroid from a living module (i.e. using inspect)
-        this is used when there is no python source code available (either
+        """Build astroid from a living module (i.e. using inspect)
+        this is used when there is no python source code available (either.


This is broken

Pierre-Sassoulas · 2022-09-22T20:52:29Z

Arg, and there's also conflicts now. Damn.

codecov · 2023-01-03T21:34:31Z

Codecov Report

Merging #1792 (d00070a) into main (b717e99) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1792   +/-   ##
=======================================
  Coverage   92.63%   92.63%           
=======================================
  Files          94       94           
  Lines       10869    10869           
=======================================
  Hits        10069    10069           
  Misses        800      800

Flag	Coverage Δ
linux	`92.40% <100.00%> (ø)`
pypy	`88.54% <100.00%> (ø)`
windows	`92.31% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
astroid/astroid_manager.py	`100.00% <ø> (ø)`
astroid/brain/brain_collections.py	`100.00% <ø> (ø)`
astroid/brain/brain_ctypes.py	`100.00% <ø> (ø)`
astroid/brain/brain_numpy_core_einsumfunc.py	`100.00% <ø> (ø)`
astroid/brain/brain_numpy_utils.py	`100.00% <ø> (ø)`
astroid/exceptions.py	`97.56% <ø> (ø)`
astroid/modutils.py	`86.79% <ø> (ø)`
astroid/objects.py	`94.01% <ø> (ø)`
astroid/test_utils.py	`85.41% <ø> (ø)`
astroid/transforms.py	`100.00% <ø> (ø)`
... and 3 more

Pierre-Sassoulas added Work in progress Documentation 📗 Maintenance Discussion or action around maintaining astroid or the dev workflow labels Sep 18, 2022

Pierre-Sassoulas commented Sep 18, 2022

View reviewed changes

Pierre-Sassoulas mentioned this pull request Sep 18, 2022

Better summary detection (no dot added in the middle of a sentence) DanielNoord/pydocstringformatter#175

Open

Pierre-Sassoulas force-pushed the add-pydocstring-formatter branch from 186df95 to 90c4e43 Compare September 19, 2022 12:30

Pierre-Sassoulas changed the title ~~Work in progress: Add pydocstringformatter~~ First modification for pep237 with pydocstringformatter Sep 19, 2022

Pierre-Sassoulas requested a review from DanielNoord September 19, 2022 12:31

Pierre-Sassoulas removed the Work in progress label Sep 19, 2022

Pierre-Sassoulas mentioned this pull request Sep 19, 2022

Work in progress: Add pydocstring formatter in pre-commit configuration #1796

Closed

DanielNoord requested changes Sep 19, 2022

View reviewed changes

Pierre-Sassoulas force-pushed the add-pydocstring-formatter branch from 90c4e43 to 45ed29b Compare January 3, 2023 21:24

Pierre-Sassoulas marked this pull request as draft January 3, 2023 21:48

[style] Apply pydocstringformatter where it's not problematic

850fa7c

Pierre-Sassoulas force-pushed the add-pydocstring-formatter branch from 45ed29b to 850fa7c Compare January 8, 2023 13:26

DanielNoord mentioned this pull request Jan 9, 2023

Initial pass with pydocstringformatter #1947

Merged

DanielNoord marked this pull request as ready for review January 9, 2023 11:41

DanielNoord added 2 commits January 9, 2023 12:42

Merge branch 'main' into add-pydocstring-formatter

6488e59

Some manual changes

d00070a

DanielNoord approved these changes Jan 9, 2023

View reviewed changes

DanielNoord enabled auto-merge (squash) January 9, 2023 11:50

DanielNoord merged commit e355324 into main Jan 9, 2023

DanielNoord deleted the add-pydocstring-formatter branch January 9, 2023 12:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First modification for pep237 with pydocstringformatter #1792

First modification for pep237 with pydocstringformatter #1792

Pierre-Sassoulas commented Sep 18, 2022 •

edited

Loading

coveralls commented Sep 18, 2022 •

edited

Loading

Pierre-Sassoulas Sep 18, 2022

DanielNoord commented Sep 18, 2022

Pierre-Sassoulas commented Sep 18, 2022

DanielNoord commented Sep 18, 2022

Pierre-Sassoulas commented Sep 18, 2022

DanielNoord commented Sep 18, 2022

Pierre-Sassoulas commented Sep 18, 2022

Pierre-Sassoulas commented Sep 19, 2022

DanielNoord Sep 19, 2022

Pierre-Sassoulas Sep 22, 2022

DanielNoord Sep 19, 2022

DanielNoord Sep 19, 2022

DanielNoord Sep 19, 2022

DanielNoord Sep 19, 2022

DanielNoord Sep 19, 2022

DanielNoord Sep 19, 2022

DanielNoord Sep 19, 2022

DanielNoord Sep 19, 2022

Pierre-Sassoulas commented Sep 22, 2022

codecov bot commented Jan 3, 2023 •

edited

Loading

First modification for pep237 with pydocstringformatter #1792

First modification for pep237 with pydocstringformatter #1792

Conversation

Pierre-Sassoulas commented Sep 18, 2022 • edited Loading

Description

Type of Changes

Related Issue

coveralls commented Sep 18, 2022 • edited Loading

Pull Request Test Coverage Report for Build 3082403333

💛 - Coveralls

Choose a reason for hiding this comment

DanielNoord commented Sep 18, 2022

Pierre-Sassoulas commented Sep 18, 2022

DanielNoord commented Sep 18, 2022

Pierre-Sassoulas commented Sep 18, 2022

DanielNoord commented Sep 18, 2022

Pierre-Sassoulas commented Sep 18, 2022

Pierre-Sassoulas commented Sep 19, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pierre-Sassoulas commented Sep 22, 2022

codecov bot commented Jan 3, 2023 • edited Loading

Codecov Report

Pierre-Sassoulas commented Sep 18, 2022 •

edited

Loading

coveralls commented Sep 18, 2022 •

edited

Loading

codecov bot commented Jan 3, 2023 •

edited

Loading