User methods 2 #122
Merged
User methods 2 #122
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This method will allow a user to query Netbox with a csv and return each device name and if they are in Netbox or not.
Missing tests added. Style changes made.
Read and validate are now in two factory methods that should make future use much easier. Created separatecommands in argparse to make the script more user friendly.
anish-mudaraddi
requested changes
Nov 20, 2023
Moved argparse functionality to each user script. Combined ReadData and ReadMethods classes. Combined ValidateData and ValidateMethods classes.
This should make further user methods easier to introduce.
anish-mudaraddi
requested changes
Nov 23, 2023
pynetbox_query/pynetboxquery/user_methods/validate_data_fields_in_netbox.py
Show resolved
Hide resolved
|
WooHoo! |
anish-mudaraddi
previously approved these changes
Nov 23, 2023
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #122 +/- ##
===========================================
- Coverage 100.00% 99.48% -0.52%
===========================================
Files 18 34 +16
Lines 446 775 +329
===========================================
+ Hits 446 771 +325
- Misses 0 4 +4 ☔ View full report in Codecov by Sentry. |
anish-mudaraddi
approved these changes
Nov 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These changes are to hopefully make the code much more reusable and segmented.
The read factory method allows files to be read in any format so long as an appropriate reading function has been written.
The validate factory method allows any data field in the device dataclass to be check in netbox so long as an appropriate function has been written to do that.
The argparse script now has subcommands that a user to display different help messages and show different command usages.
There are currently two user scripts:
upload_devices_to_netbox.pyandvalidate_data_fields_in_netbox.py. Both of these scripts should be very simple and only differ by calling each factory method with different arguments.The code is not finished yet and tests are not written/ do not work. Hence why this is a draft.
I have not made any changes to the
netbox_get_idparts of the project yet as it's a little more complicated but would like to have that method in a sort of factory method likereadandvalidate.Docstrings should be very explanative and if they are not please say so!