search

mhostetter / sdr

A Python package for software-defined radio
https://mhostetter.github.io/sdr/
MIT License
36 stars 4 forks source link

Support none docstrings #385

Closed jcharlong closed 2 months ago

jcharlong commented 2 months ago

Hello,

I ran into an issue running sdr code with CPython's -OO flag which optimizes out docstrings. The issue can be reproduced by running tests with python -OO -m pylint tests/.

This branch contains a solution broken into 2 commits:

  1. Check for and handle None docstrings within sdr's helper function.
  2. Require galois version 0.3.9 which brings support for CPython's -OO flag.

My branch is based off of release/0.0.x & I've ensured it passes ruff & the unit tests locally (w/ -OO).

Let me know if there's anything I missed or can do to facilitate merging this PR. Thank you in advance.

mhostetter commented 2 months ago

Thanks for the PR. Looks good to me!

One note, I noticed in your PR to galois that your commits aren't linked to your GitHub profile. (If you hover over your name in the commit history, it doesn't link to your GitHub page.) Because of that, you don't automatically appear in the "Contributors" list for this repo. If you care about that, I think this link could help.

image

jcharlong commented 2 months ago

Ah, thanks. I hastily access to my personal GitHub account on my work machine for these 2 PRs. I wouldn't bother holding up the PR for this, but I appreciate the head's up & will address it.

mhostetter commented 2 months ago

Thanks for this! I was planning on releasing the next version on Sunday. I can easily push a release tonight though, if you're looking to pull the latest sooner.

jcharlong commented 2 months ago

Thanks for the quick merge & support. Sunday would work well, I don't think any sooner makes a difference on my end.