search

rbroderi / flake8_require_beartype

MIT License
2 stars 0 forks source link

[Organizational] As a @beartype bro, allow me to just mutter... #1

Open leycec opened 1 year ago

leycec commented 1 year ago

This is awesome sauce! Actually... allow me to start over.

Hi! This is @leycec, @rbroderi. Bearded bear bros, unite. :man_beard:

I still love your GitHub Avatar. It feels me with indescribable childhood nostalgia. It also fills me with painful flashbacks to playing flutes alone in graveyards, which I then wilfully desecrate by pushing tombstones around until a dungeon filled with horrifying monsters magically appears.

The 80's: it was a different time.

What I'm trying to say here is... I'd love to promote this package! Would you like to officially join the @beartype family at a new URL of https://github.com/beartype/flake8_require_beartype? Of course, you'd still retain full control over everything here – including your own GitHub Sponsors-driven monetization if you wanted to pay for weekend all-night binge-drinking coffee and tea. do it, do it If so, just lemme know; else, feel free to quietly close this and pretend this embarrassing episode in your life never happened. Also...

Classes: Yup, @beartype does that too now

@beartype now supports class decoration as of beartype ≥ 0.11.0. We rejoice.

In fact, class decoration is strongly preferable to method decoration. There are increasingly many classes of type hints that can only be runtime type-checked when @beartype is applied as a class decorator (e.g., typing.Self).

If you find a spare weekend full of copious free time, this plugin should (probably) advise that undecorated classes be decorated by @beartype. Undecorated methods should (probably) then be silently ignored. Maybe. Possibly. Assuming that is even feasible. Which it might not be.

Static analysis is rough stuff, indeed.

Documentation: Yup, we should promote this plugin.

@beartype documentation now officially lives at ReadTheDocs (RTD). My single goal this year is to transition the entirety of our README.rst to RTD. We can do this... and we must!

Meanwhile, we should promote this plugin in our FAQ. I am envisioning a new FAQ entry that reads something like:

Can I ensure that my code is protected by @beartype?

Yes! Just:

  1. Install Flake8.
  2. Install the official flake8_require_beartype plugin.
  3. Enable Flake8 in your IDE of choice, which is of course Vim.

Then watch the :bear: :muscle:.

rbroderi commented 1 year ago

Hey thanks for the email. That all sounds great. I'll need to clean up the code as it still is kinda proof of concept, but I can look at it over the next week or so and get it in shape to be made official.

On Tue, Feb 7, 2023, 1:17 AM Cecil Curry @.***> wrote:

This is awesome sauce! Actually... allow me to start over.

Hi! This is @leycec https://github.com/leycec, @rbroderi https://github.com/rbroderi. Bearded bear bros, unite. 🧔‍♂️

I still love your GitHub Avatar. It feels me with indescribable childhood nostalgia. It also fills me with painful flashbacks to playing flutes alone in graveyards, which I then wilfully desecrate by pushing tombstones around until a dungeon filled with horrifying monsters magically appears.

The 80's: it was a different time.

What I'm trying to say here is... I'd love to promote this package! Would you like to officially join the @beartype https://github.com/beartype family at a new URL of https://github.com/beartype/flake8_require_beartype? Of course, you'd still retain full control over everything here – including your own GitHub Sponsors-driven monetization if you wanted to pay for weekend all-night binge-drinking coffee and tea. do it, do it If so, just lemme know; else, feel free to quietly close this and pretend this embarrassing episode in your life never happened. Also... Classes: Yup, @beartype https://github.com/beartype does that too now

@beartype https://github.com/beartype now supports class decoration as of beartype ≥ 0.11.0. We rejoice.

In fact, class decoration is strongly preferable to method decoration. There are increasingly many classes of type hints that can only be runtime type-checked when @beartype https://github.com/beartype is applied as a class decorator (e.g., typing.Self).

If you find a spare weekend full of copious free time, this plugin should (probably) advise that undecorated classes be decorated by @beartype https://github.com/beartype. Undecorated methods should (probably) then be silently ignored. Maybe. Possibly. Assuming that is even feasible. Which it might not be.

Static analysis is rough stuff, indeed. Documentation: Yup, we should promote this plugin.

@beartype documentation now officially lives at ReadTheDocs (RTD) https://beartype.readthedocs.io/en/latest. My single goal this year is to transition the entirety of our README.rst to RTD. We can do this... and we must!

Meanwhile, we should promote this plugin in our FAQ. I am envisioning a new FAQ entry that reads something like: Can I ensure that my code is protected by @beartype https://github.com/beartype?

Yes! Just:

  1. Install Flake8 https://flake8.pycqa.org.
  2. Install the official flake8_require_beartype https://github.com/rbroderi/flake8_require_beartype plugin.
  3. Enable Flake8 https://flake8.pycqa.org in your IDE of choice, which is of course Vim.

Then watch the 🐻 💪.

— Reply to this email directly, view it on GitHub https://github.com/rbroderi/flake8_require_beartype/issues/1, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADZF2W3SDKMX366RXWA4NETWWHSJHANCNFSM6AAAAAAUTRPKMY . You are receiving this because you were mentioned.Message ID: @.***>

leycec commented 1 year ago

Absolutely no worries. We're all about the fun and not at all about the hard deliverables. Since everybody's (mostly) unpaid here, nobody can complain! Freedom is the only rule here. Take the entirety of your time. Whatever you come up with will be wonderful, because you are @rbroderi.

Until then, I continue beating Sphinx repeatedly until it submits to @beartype. :grin: