feat: allow file paths to be passed in as pathlike objects

[kimboleh]

Proposed changes

Allows for functions/methods/classes to accept pathlib.Path objects in addition to just strings.

Addresses #33

---

Most of these changes involve simply adding a Union type to allow for either a str or a Path object type to be passed in as a file path. There are a couple of places where isinstance logic has been implemented to handle a possible non-string in the form of a Path object.

Most of the functionality is tested simply by passing Path objects to the read_file and write_file methods, as most other functions simply pass their file paths on to those functions, but I've added testing for Path objects throughout the tests just to be thorough. A secondary look to make sure I have thorough coverage would be welcome.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Functionality update (non-breaking change which updates or changes existing functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• CI/CD update (an update to the CI/CD workflows, scripts, and/or configurations)
• Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

• I have followed the guidelines in the CONTRIBUTING document
• I have signed the CLA
• I have checked to ensure there aren't other open Pull Requests for the same update/change
• I have created (or updated) an Issue to track the status of this update/change and updated the link in this PR description (see above in the Proposed changes section) using the wording Addresses #<issue_number>
• I have performed a self-review of my code
• My code follows the style guidelines of this project
• I have commented my code, particularly in hard-to-understand areas
• Basic linting passes locally with my changes
• Note: The safety pre-commit hook fails locally for me with cannot import name 'build_client_session' from 'safety.auth' - this reproduces on main and appears to be a pre-existing dependency issue, or possibly something on my machine. I bypassed it with --no-verify to commit, but please let me know if there's something I need to fix there.
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• I have added necessary documentation (if appropriate)
• I have updated the Changelog with a brief description of my changes

[CLAassistant]

All committers have signed the CLA.

[nfelt14]

There might be a better way to do this if you convert it to a Path object

[kimboleh]

I just pushed an update for this if you want to check it - definitely a cleaner way to handle things.

[github-actions]

Breaking API Changes

src/tm_data_types/io_factory_methods.py:30: write_file(path):
Parameter was removed

src/tm_data_types/io_factory_methods.py:30: write_file(file_path):
Parameter was added as required

Link to workflow run

[github-actions]

Test Results (macos)

path	passed	skipped	subtotal
tests/test_tm_data_types.py	20	1	21
TOTAL	20	1	21

tests/test_tm_data_types.py

('/Users/runner/work/tm_data_types/tm_data_types/tests/test_tm_data_types.py', 602, 'Skipped: Skipping 1G test in GitHub Actions environment')

Link to workflow run

[github-actions]

Test Results (ubuntu)

path	passed	skipped	subtotal
tests/test_tm_data_types.py	20	1	21
TOTAL	20	1	21

tests/test_tm_data_types.py

('/home/runner/work/tm_data_types/tm_data_types/tests/test_tm_data_types.py', 602, 'Skipped: Skipping 1G test in GitHub Actions environment')

Link to workflow run

[github-actions]

Test Results (windows)

path	passed	skipped	subtotal
tests\test_tm_data_types.py	20	1	21
TOTAL	20	1	21

tests\test_tm_data_types.py

('D:\\a\\tm_data_types\\tm_data_types\\tests\\test_tm_data_types.py', 602, 'Skipped: Skipping 1G test in GitHub Actions environment')

Link to workflow run