Backward compatibility: Add Deprecated fields #1983
Merged
Conversation
This file contains hidden or 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
Codecov Report
@@ Coverage Diff @@
## master #1983 +/- ##
==========================================
- Coverage 87.18% 86.44% -0.75%
==========================================
Files 197 197
Lines 44486 44507 +21
==========================================
- Hits 38787 38472 -315
- Misses 5699 6035 +336
|
gpotter2
commented
Apr 13, 2019
| @@ -84,7 +85,11 @@ def _read_config_file(cf, _globals=globals(), _locals=locals(), interactive=True | |||
| """ | |||
| log_loading.debug("Loading config file [%s]", cf) | |||
| try: | |||
| exec(compile(open(cf).read(), cf, 'exec'), _globals, _locals) | |||
There was a problem hiding this comment.
Random unclosed file triggered by the new detection
|
Also ready despite the failing codecov test |
|
I like this idea but I have some comments:
|
|
Thanks for the suggestions, I've updated the PR. So you think that we should allow |
|
Throwing the exception is IMHO the only valid option to warn users =)
|
|
Got it, updated (Please squash when merging) |
Merged
|
@guedou This is ready for review ! |
guedou
reviewed
Jun 25, 2019
scapy/layers/dot11.py
Outdated
| @@ -247,6 +247,11 @@ def guess_payload_class(self, pay): | |||
|
|
|||
| class RadioTap(Packet): | |||
| name = "RadioTap dummy" | |||
| deprecated_fields = { | |||
| "Channel": "ChannelFrequency", # 2.4.3 | |||
There was a problem hiding this comment.
I wonder if the version should be part of the deprecation API. It might ease our future selves while debugging issues =)
guedou
previously approved these changes
Jun 25, 2019
p-l-
requested changes
Jun 25, 2019
Co-Authored-By: Pierre Lalet <[email protected]>
gpotter2
changed the title
guedou
approved these changes
Jun 27, 2019
p-l-
approved these changes
Jun 27, 2019
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.
Rationale: Scapy is pretty bad at keeping things backward compatible. Fields are renamed often for consistency, therefore breaking older stuff. Moreover, because the release schedule is so slow, people aren't warned of changes.
This PR is an attempt to improve this by:
alias_fieldsthat redirects to another field with an optionalDeprecationWarning. We already have use cases for that: RadioTap Dummy Channel vs. Frequency confusion #1979 Bluetooth LE: multiple improvements #1855. This would allow to migrate old scapy fields to newer names, without breaking too much stuff too quicklyNot sure how this affects performance. Adding stuff to
get_field& co never is great