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

gh-117348: Refactored RawConfigParser._read for simplicity and comprehensibility #117372

Merged
merged 23 commits into from
Mar 29, 2024
Merged

gh-117348: Refactored RawConfigParser._read for simplicity and comprehensibility #117372

merged 23 commits into from
Mar 29, 2024

Commits on Mar 29, 2024

  1. Extract method for _read_inner, reducing complexity and indentation b… 

    …y 1.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    a25ac00 View commit details
    Browse the repository at this point in the history

  2. Extract method for _raise_all and yield ParseErrors from _read_inner. 

    Reduces complexity by 1 and reduces touch points for handling errors in _read_inner.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    1e69aae View commit details
    Browse the repository at this point in the history

  3. Prefer iterators to splat expansion and literal indexing.

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    8c47781 View commit details
    Browse the repository at this point in the history

  4. Extract method for _strip_comments. Reduces complexity by 7.

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    7479814 View commit details
    Browse the repository at this point in the history

  5. Model the file lines in a class to encapsulate the comment status and… 

    … cleaned value.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    a2fffee View commit details
    Browse the repository at this point in the history

  6. Encapsulate the read state as a dataclass

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    23468cb View commit details
    Browse the repository at this point in the history

  7. Extract _handle_continuation_line and _handle_rest methods. Reduces c… 

    …omplexity by 8.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    3d1ef0a View commit details
    Browse the repository at this point in the history

  8. Reindent

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    071baeb View commit details
    Browse the repository at this point in the history

  9. At least for now, collect errors in the ReadState

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    81f4ce2 View commit details
    Browse the repository at this point in the history

  10. Check for missing section header separately.

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    8942cc1 View commit details
    Browse the repository at this point in the history

  11. Extract methods for _handle_header and _handle_option. Reduces comple… 

    …xity by 6.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    1e72168 View commit details
    Browse the repository at this point in the history

  12. Remove unreachable code. Reduces complexity by 4.

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    0dfd797 View commit details
    Browse the repository at this point in the history

  13. Remove unreachable branch

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    77ed897 View commit details
    Browse the repository at this point in the history

  14. Handle error condition early. Reduces complexity by 1.

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    76f42d3 View commit details
    Browse the repository at this point in the history

  15. Add blurb

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    c18a2bb View commit details
    Browse the repository at this point in the history

  16. Move _raise_all to ParsingError, as its behavior is most closely rela… 

    …ted to the exception class and not the reader.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    97aa785 View commit details
    Browse the repository at this point in the history

  17. Split _strip* into separate methods.

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    d310cb4 View commit details
    Browse the repository at this point in the history

  18. Refactor _strip_full to compute the strip just once and use 'not any'… 

    … to determine the factor.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    f2a355c View commit details
    Browse the repository at this point in the history

  19. Replace use of 'sys.maxsize' with direct computation of the stripped … 

    …value.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    2492614 View commit details
    Browse the repository at this point in the history

  20. Extract has_comments as a dynamic property.

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    4968591 View commit details
    Browse the repository at this point in the history

  21. Implement clean as a cached property.

    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    7d807bb View commit details
    Browse the repository at this point in the history

  22. Model comment prefixes in the RawConfigParser within a prefixes names… 

    …pace.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    29cb20f View commit details
    Browse the repository at this point in the history

  23. Use a regular expression to search for the first match. 

    Avoids mutating variables and tricky logic and over-computing all of the starts when only the first is relevant.
    @jaraco
    jaraco committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    c834c35 View commit details
    Browse the repository at this point in the history