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

Add comments/docstrings to exceptions #1873

Merged
merged 68 commits into from
Jun 27, 2024
Merged

Add comments/docstrings to exceptions #1873

merged 68 commits into from
Jun 27, 2024

Commits on May 9, 2024

  1. Add comment for EntraID error

    @craddm
    craddm committed May 9, 2024
    Configuration menu
    Copy the full SHA
    95dbc72 View commit details
    Browse the repository at this point in the history

Commits on May 10, 2024

  1. Move comment to docstring

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    d82fd48 View commit details
    Browse the repository at this point in the history

  2. Add docstring for configerror

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    fef1660 View commit details
    Browse the repository at this point in the history

  3. Add docstring for SSLError

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    16ab4af View commit details
    Browse the repository at this point in the history

  4. shorten descriptive text in docstrings

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    6b9e4c7 View commit details
    Browse the repository at this point in the history

  5. Add docstring for CloudError

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    20b0693 View commit details
    Browse the repository at this point in the history

  6. Add docstring for CloudError

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    0c97db8 View commit details
    Browse the repository at this point in the history

  7. Add docstring for IPRangeError

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    a3249c9 View commit details
    Browse the repository at this point in the history

  8. Finish AzureError docstring, add for DataSafeHavenError

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    bbcf278 View commit details
    Browse the repository at this point in the history

  9. Add docstring for DataSafeHavenError

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    09736be View commit details
    Browse the repository at this point in the history

  10. SSLError docstring

    @craddm
    craddm committed May 10, 2024
    Configuration menu
    Copy the full SHA
    0ed15f5 View commit details
    Browse the repository at this point in the history

Commits on May 13, 2024

  1. Merge branch 'alan-turing-institute:develop' into add-exception-comments

    @craddm
    craddm committed May 13, 2024
    Configuration menu
    Copy the full SHA
    81f8914 View commit details
    Browse the repository at this point in the history

Commits on May 14, 2024

  1. add .venv/ to gitignore

    @craddm
    craddm committed May 14, 2024
    Configuration menu
    Copy the full SHA
    bd33362 View commit details
    Browse the repository at this point in the history

Commits on May 15, 2024

  1. add several further expection docstrings

    @craddm
    craddm committed May 15, 2024
    Configuration menu
    Copy the full SHA
    6de1f1d View commit details
    Browse the repository at this point in the history

  2. Add additional exception docstrings

    @craddm
    craddm committed May 15, 2024
    Configuration menu
    Copy the full SHA
    30d104a View commit details
    Browse the repository at this point in the history

  3. document use of DSHInputError

    @craddm
    craddm committed May 15, 2024
    Configuration menu
    Copy the full SHA
    ccddc09 View commit details
    Browse the repository at this point in the history

  4. Use Pulumi error for consistency

    @craddm
    craddm committed May 15, 2024
    Configuration menu
    Copy the full SHA
    ffa682e View commit details
    Browse the repository at this point in the history

Commits on Jun 24, 2024

  1. Merge branch 'develop' into add-exception-comments

    @jemrobinson
    jemrobinson committed Jun 24, 2024
    Configuration menu
    Copy the full SHA
    599ed03 View commit details
    Browse the repository at this point in the history

Commits on Jun 25, 2024

  1. Merge branch 'alan-turing-institute:develop' into add-exception-comments

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    f95d611 View commit details
    Browse the repository at this point in the history

  2. Add more detailed comments and notes for error classes

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    d4c4dff View commit details
    Browse the repository at this point in the history

  3. Remove DataSafeHavenNotImplementedError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    f420e41 View commit details
    Browse the repository at this point in the history

  4. Merge branch 'develop' into add-exception-comments

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    b3a932c View commit details
    Browse the repository at this point in the history

  5. Remove unnecessary spaces

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    71e4e1e View commit details
    Browse the repository at this point in the history

  6. Reorder error classes

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    0cc6331 View commit details
    Browse the repository at this point in the history

  7. Grammar fixes

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    8dbb4ab View commit details
    Browse the repository at this point in the history

  8. More concise docstring for IPRangeError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    8582ca6 View commit details
    Browse the repository at this point in the history

  9. Make userhandlingerror no longer an internalerror

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    ca347e2 View commit details
    Browse the repository at this point in the history

  10. remove internalerror from azure_api and replace with AzureError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    ee71d15 View commit details
    Browse the repository at this point in the history

  11. Add DSHType andDSHValue Error classes

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    09a9a12 View commit details
    Browse the repository at this point in the history

  12. change parameter errors to valueerrors

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    6ef4800 View commit details
    Browse the repository at this point in the history

  13. Change DSHInputErrors to DSHTypeErrors for Entra users

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    681285e View commit details
    Browse the repository at this point in the history

  14. Change from InputError to ValueError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    0c049df View commit details
    Browse the repository at this point in the history

  15. Change from InputError to ValueError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    0adda50 View commit details
    Browse the repository at this point in the history

  16. Change from InputError to ValueError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    edbfcd6 View commit details
    Browse the repository at this point in the history

  17. Remove DSHInputError class

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    c3fcdfe View commit details
    Browse the repository at this point in the history

  18. Replace InputError with ValueError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    951205a View commit details
    Browse the repository at this point in the history

  19. Replace DSHInputError with DSHPulumiError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    5e84f06 View commit details
    Browse the repository at this point in the history

  20. Fix linting errors

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    d4abfc2 View commit details
    Browse the repository at this point in the history

  21. Replace DSHInternal with DSHMicrosoftGraph errors

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    88fe681 View commit details
    Browse the repository at this point in the history

  22. Replace ParameterError with TypeError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    354ccf9 View commit details
    Browse the repository at this point in the history

  23. fix linting error

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    a7b110a View commit details
    Browse the repository at this point in the history

  24. Update strings tests to check for Value rather than Input errors

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    fb29ffb View commit details
    Browse the repository at this point in the history

  25. Remove DSHInternalError class

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    277663b View commit details
    Browse the repository at this point in the history

  26. Update tests from ParameterError to TypeError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    afa9272 View commit details
    Browse the repository at this point in the history

  27. Update tests to reflect changes in error types

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    2a7e42b View commit details
    Browse the repository at this point in the history

  28. Change ParameterError to TypeError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    6a31329 View commit details
    Browse the repository at this point in the history

  29. Change ParameterError to Type and ValueErrors as applicable

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    ece0a8c View commit details
    Browse the repository at this point in the history

  30. Change to DSHTypeError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    3fd1a1f View commit details
    Browse the repository at this point in the history

  31. Remove DSHParameterError class

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    9c24d7c View commit details
    Browse the repository at this point in the history

  32. Change tests to check for TypeError

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    d6d1dff View commit details
    Browse the repository at this point in the history

  33. Decode bytes for printing

    @craddm
    craddm committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    5598759 View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2024

  1. Merge branch 'alan-turing-institute:develop' into add-exception-comments

    @craddm
    craddm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    2ed00ca View commit details
    Browse the repository at this point in the history

  2. Fix expected exception message in tests

    @JimMadge
    JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    5b8afff View commit details
    Browse the repository at this point in the history

  3. Change AzureAPIAuthenticationError parent 

    This prevents allows us to catch this exception specifically and give
useful feedback to the user.
    @JimMadge
    JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    65b8888 View commit details
    Browse the repository at this point in the history

  4. Fix linting

    @JimMadge
    JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    7d48502 View commit details
    Browse the repository at this point in the history

  5. Update data_safe_haven/exceptions/__init__.py 

    Co-authored-by: Jim Madge <jim+github@jmadge.com>
    @craddm @JimMadge
    craddm and JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    6f8b99e View commit details
    Browse the repository at this point in the history

  6. Update data_safe_haven/exceptions/__init__.py 

    Co-authored-by: Jim Madge <jim+github@jmadge.com>
    @craddm @JimMadge
    craddm and JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    f7bd0cf View commit details
    Browse the repository at this point in the history

  7. Update data_safe_haven/exceptions/__init__.py 

    Co-authored-by: Jim Madge <jim+github@jmadge.com>
    @craddm @JimMadge
    craddm and JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    9a80026 View commit details
    Browse the repository at this point in the history

  8. Update data_safe_haven/exceptions/__init__.py 

    Co-authored-by: Jim Madge <jim+github@jmadge.com>
    @craddm @JimMadge
    craddm and JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    9e38d1e View commit details
    Browse the repository at this point in the history

  9. Update data_safe_haven/exceptions/__init__.py 

    Co-authored-by: Jim Madge <jim+github@jmadge.com>
    @craddm @JimMadge
    craddm and JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    a4bc4ad View commit details
    Browse the repository at this point in the history

  10. Update data_safe_haven/exceptions/__init__.py 

    Co-authored-by: Jim Madge <jim+github@jmadge.com>
    @craddm @JimMadge
    craddm and JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    319fbc7 View commit details
    Browse the repository at this point in the history

  11. Update data_safe_haven/exceptions/__init__.py 

    Co-authored-by: Jim Madge <jim+github@jmadge.com>
    @craddm @JimMadge
    craddm and JimMadge committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    f1709bb View commit details
    Browse the repository at this point in the history

  12. Use typer.Exit() pattern

    @craddm
    craddm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    1da2f5a View commit details
    Browse the repository at this point in the history

  13. Change to raise typer.Exit(1) pattern

    @craddm
    craddm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    ab0ca99 View commit details
    Browse the repository at this point in the history

  14. place message directly in logger call

    @craddm
    craddm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    b30af88 View commit details
    Browse the repository at this point in the history

  15. fix linting

    @craddm
    craddm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    43a9698 View commit details
    Browse the repository at this point in the history

Commits on Jun 27, 2024

  1. Replace remaining non-typer, terminating raises

    @JimMadge
    JimMadge committed Jun 27, 2024
    Configuration menu
    Copy the full SHA
    8caebec View commit details
    Browse the repository at this point in the history

  2. Fix linting

    @JimMadge
    JimMadge committed Jun 27, 2024
    Configuration menu
    Copy the full SHA
    c45f705 View commit details
    Browse the repository at this point in the history