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

Deprecate several utility functions #188

Merged
merged 2 commits into from
Sep 25, 2024

Conversation

kurtmckee
Copy link
Contributor

@kurtmckee kurtmckee commented Sep 25, 2024

This PR introduces the following changes:

  • Deprecate two utility functions and their aliases
  • Add type annotations to utility functions
  • Update utility function doc strings
  • Use newer Python constructs to simplify remaining code

@coveralls
Copy link

coveralls commented Sep 25, 2024

Coverage Status

coverage: 43.87% (-16.2%) from 60.085%
when pulling d71d968 on kurtmckee:utility-functions
into de690e7 on LudovicRousseau:master.

src/smartcard/util/__init__.py Show resolved Hide resolved
src/smartcard/util/__init__.py Show resolved Hide resolved
In addition,

* Add type annotations to utility functions
* Update utility function doc strings
* Use newer Python constructs to simplify remaining code
@kurtmckee kurtmckee changed the title Remove several utility functions Deprecate several utility functions Sep 25, 2024
@LudovicRousseau
Copy link
Owner

You should also update the documentation to replace calls to deprecated functions

https://github.com/LudovicRousseau/pyscard/blob/master/src/smartcard/doc/user-guide.rst#binary-strings-and-list-of-bytes

@kurtmckee
Copy link
Contributor Author

Shoot, I had been filtering my search to .py files. Yep, I'll get that updated. Thanks!

@kurtmckee
Copy link
Contributor Author

Hmm, that section is part of a discussion about cryptography, but specifically pycrypto, which hasn't had a release in 11 years.

I'll make a quick update to that section, but this has informed me that there's some additional work to do with that section on cryptography. 👍

@LudovicRousseau
Copy link
Owner

You can update the documentation in a different commit.
It will be easier to review.

This commit also updates an example for SHA-1 and MD5 hashing.
@kurtmckee
Copy link
Contributor Author

I included an update for SHA-1 and MD5 hashing that makes the docs for that section usable.

@LudovicRousseau LudovicRousseau merged commit 1baa8ea into LudovicRousseau:master Sep 25, 2024
7 of 21 checks passed
@LudovicRousseau
Copy link
Owner

Thanks

@kurtmckee kurtmckee deleted the utility-functions branch September 25, 2024 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants