Python allows programmers to pass additional arguments to functions via comments. Now armed with this knowledge head out and spread it to all code bases.

Feel free to use the code I wrote in your projects.

Link to the source code: https://github.com/raldone01/python_lessons_py/blob/v2.0.0/lesson_0_comments.ipynb

Image transcription:

# First we have to import comment_arguments from arglib
# Sadly arglib is not yet a standard library.
from arglib import comment_arguments


def add(*args, **kwargs):
    c_args, c_kwargs = comment_arguments()
    return sum([int(i) for i in args + c_args])


# Go ahead and change the comments.
# See how they are used as arguments.

result = add()  # 1, 2
print(result)
# comment arguments can be combined with normal function arguments
result = add(1, 2)  # 3, 4
print(result)

Output:

3
10

This is version v2.0.0 of the post: https://github.com/raldone01/python_lessons_py/tree/v2.0.0

Note:

v1.0.0 of the post can be found here: https://github.com/raldone01/python_lessons_py/tree/v1.0.0

Choosing lib as the name for my module was a bit devious. I did it because I thought if I am creating something cursed why not go all the way?

Regarding misinformation:

I thought simply posting this in programmer humor was enough. Anyways, the techniques shown here are not yet regarded best practice. Decide carefully if you want to apply the shown concepts in your own code bases.

  • bdonvr@thelemmy.club
    link
    fedilink
    arrow-up
    192
    ·
    1 month ago

    IMO comments should never ever be parsed under any circumstances but I probably don’t know enough to really speak on this

        • raldone01@lemmy.worldOP
          link
          fedilink
          English
          arrow-up
          36
          ·
          edit-2
          27 days ago

          On a serious note:

          This feature is actually very useful. Libraries can use it create neat error messages. It is also needed when logging information to a file.

          You should however never ever parse the source code and react to it differently.

    • bjorney@lemmy.ca
      link
      fedilink
      arrow-up
      16
      ·
      1 month ago

      The add function in the example above probably traverses the call stack to see what line of the script is currently being executed by the interpreter, then reads in that line in the original script, parses the comment, and subs in the values in the function call.

      This functionality exists so when you get a traceback you can see what line of code triggered it in the error message

    • jaxxed@lemmy.world
      link
      fedilink
      arrow-up
      7
      ·
      29 days ago

      Can we just clarify that you mean that comments should never be parsed by the language engine. There are valid annotation systems, but the goal is alway to ensure that one passable can never impact the other.

      Imagine if here a comment could create a syntax error! This is even worse for runtime scripting languages like python.

    • Artyom@lemm.ee
      link
      fedilink
      arrow-up
      5
      ·
      1 month ago

      This isn’t standard python. lib is not in the standard library. Python also doesn’t have any special variables where it stores comments, other than __doc__ which stores a docstring. If I had to guess, add is reading the file/REPL via __file__.

      • lud@lemm.ee
        link
        fedilink
        arrow-up
        7
        ·
        1 month ago

        Python is an interpreted language but for a compiled language absolutely (and obviously).

      • raldone01@lemmy.worldOP
        link
        fedilink
        English
        arrow-up
        4
        ·
        edit-2
        27 days ago

        Well now that causes breakage two dependencies down the line. Good luck with that. 😅

    • ahal@lemmy.ca
      link
      fedilink
      arrow-up
      3
      ·
      1 month ago

      Ignoring lint issues comes to mind as an at least somewhat reasonable use case.

    • Badland9085@lemm.ee
      link
      fedilink
      arrow-up
      3
      ·
      1 month ago

      One case where I find it useful, tho it operates in a more limited way, is code in block blocks within code comments in Rust, which are also printed out in the generated documentation. They essentially get ran as part of your unit tests. This is great for making sure that, eg, your examples left in code comments actually work, especially if they’re written in a way that functions like a unit test.

    • peereboominc@lemm.ee
      link
      fedilink
      English
      arrow-up
      2
      ·
      1 month ago

      Some languages use the comments to generate documentation. Something like

      // function to add two numbers func Add(num1 int, num2 int)

    • balsoft@lemmy.ml
      link
      fedilink
      arrow-up
      2
      ·
      1 month ago

      It’s quite useful to parse comments and generate documentation from them, either as plain old hypertext or in your editor with LSP.

      • ramble81@lemm.ee
        link
        fedilink
        arrow-up
        6
        ·
        1 month ago

        That sounds fine if you have something reading the file independently. But the actual executable code should not be able to access its own comments.

        • kchr@lemmy.sdf.org
          link
          fedilink
          arrow-up
          1
          ·
          30 days ago

          Comments aren’t normally accessible unless you (independently) open and read the source code file as you would with any arbitrary file.