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.

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

Automotive documentation and Typing [ready] #3075

Merged
merged 26 commits into from
May 3, 2021

Conversation

polybassa
Copy link
Contributor

@polybassa polybassa commented Jan 29, 2021

I've started a new series of documentation improvements.
This PR improves the API documentation of CAN and PythonCANSockets and adds typing to CAN, PythonCANSockets and NativeCANSockets

@codecov
Copy link

codecov bot commented Jan 29, 2021

Codecov Report

Merging #3075 (d4c8777) into master (cc34f80) will increase coverage by 0.28%.
The diff coverage is 63.15%.

@@            Coverage Diff             @@
##           master    #3075      +/-   ##
==========================================
+ Coverage   85.03%   85.32%   +0.28%     
==========================================
  Files         265      265              
  Lines       54956    54962       +6     
==========================================
+ Hits        46732    46896     +164     
+ Misses       8224     8066     -158     
Impacted Files Coverage Δ
scapy/supersocket.py 59.81% <ø> (+0.30%) ⬆️
scapy/contrib/cansocket_native.py 16.94% <5.55%> (+2.45%) ⬆️
scapy/contrib/cansocket.py 66.66% <33.33%> (+8.33%) ⬆️
scapy/contrib/cansocket_python_can.py 82.50% <93.54%> (-0.29%) ⬇️
scapy/contrib/automotive/xcp/xcp.py 91.42% <100.00%> (ø)
scapy/layers/can.py 94.75% <100.00%> (+0.03%) ⬆️
scapy/layers/sixlowpan.py 86.31% <0.00%> (-0.26%) ⬇️
scapy/layers/tls/automaton_cli.py 70.96% <0.00%> (-0.10%) ⬇️
scapy/layers/dot11.py 90.53% <0.00%> (+0.01%) ⬆️
scapy/pipetool.py 86.09% <0.00%> (+0.03%) ⬆️
... and 25 more

@polybassa
Copy link
Contributor Author

Uuups appveyor got canceled.

@polybassa polybassa closed this Jan 29, 2021
@polybassa polybassa reopened this Jan 29, 2021
@polybassa
Copy link
Contributor Author

@gpotter2 This PR is ready for review

@gpotter2
Copy link
Member

Thanks for the PR. I'd however like for the sendrecv typing PR to be merged beforehand.

@polybassa
Copy link
Contributor Author

Alright, no problem.

@polybassa
Copy link
Contributor Author

waiting for #3059

@polybassa
Copy link
Contributor Author

@gpotter2 Rebased and ready for review. This PR changes the typing of select. Hope that change is legit.

@gpotter2
Copy link
Member

The typing of select is changed in #3090 too. You can probably rebase on top of it in the meantime :/

scapy/contrib/cansocket_python_can.py Outdated Show resolved Hide resolved
tox.ini Show resolved Hide resolved
@polybassa polybassa closed this Mar 2, 2021
@polybassa polybassa reopened this Mar 2, 2021
@gpotter2
Copy link
Member

Sorry for the delay. I'm waiting for 2.4.5..

@polybassa
Copy link
Contributor Author

polybassa commented Mar 12, 2021

No problem... I think, after #3090 I need to change some minor things in this PR and in #3078.
So I'm fine, waiting for #3100

@polybassa
Copy link
Contributor Author

@gpotter2 Rebased.

@polybassa polybassa closed this Mar 13, 2021
@polybassa polybassa reopened this Mar 13, 2021
@polybassa polybassa closed this Mar 13, 2021
@polybassa polybassa reopened this Mar 13, 2021
@@ -100,6 +100,9 @@
# Enable codeauthor and sectionauthor directives
show_authors = True

# Mock python-can
autodoc_mock_imports = ["can"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job for finding this out, I didn't know it was builtin.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@polybassa
Copy link
Contributor Author

Can this PR get merged?

@gpotter2 gpotter2 merged commit 4cf5574 into secdev:master May 3, 2021
bzalkilani pushed a commit to bzalkilani/scapy that referenced this pull request Jun 12, 2022
@polybassa polybassa deleted the Automotive_documentation branch July 27, 2022 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants