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
    2011 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
          38
          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.

          • @ddplf@szmer.info
            link
            fedilink
            -31 month ago

            Because it doesn’t seem like a useful feature. The only occasion I imagine this could be helpful is with logging to the console to track when the function breaks, but even then - still trivial to replace.

        • Rikudou_SageA
          link
          English
          11 month ago

          A lot of languages expose it for debugging purposes. It’s available in pretty much every mainstream language (though in some it’s a little more involved, like Java’s new Exception().getStackTrace()[0].getLineNumber()).

      • Rikudou_SageA
        link
        English
        11 month ago

        That’s horrible. Every sane person would filter out lines containing comments to find the correct index.

        • @raldone01@lemmy.worldOP
          link
          fedilink
          English
          1
          edit-2
          27 days ago

          This should be a build step. Preprocess before the preprocessor. All line number will be off depending on the comments. 😂

          Unless…

          C with source maps!!! Thank js for the cool solution.

    • bjorney
      link
      fedilink
      171 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
      link
      fedilink
      830 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.

      • @bastion@feddit.nl
        link
        fedilink
        929 days ago

        Sure, but let’s just clarify that this is someone going out of their way to create this problem, using Python’s ability to read it’s own code.

        Basically, you can load any text file, including a source code file, and do whatever you want with it.

        So, a function can be written that finds out whatever’s calling it, reads that file, parses the comments, and uses them as values. This can also be done with introspection, using the same mechanism that displays tracebacks.

    • @Artyom@lemm.ee
      link
      fedilink
      51 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__.

        • @Artyom@lemm.ee
          link
          fedilink
          230 days ago

          It’s a string, although sometimes Python conflates the two. The recommended way to make a multi-line comment is to just make a multi-line string and just don’t use it.

    • @Badland9085@lemm.ee
      link
      fedilink
      31 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.

    • @ahal@lemmy.ca
      link
      fedilink
      31 month ago

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

    • @balsoft@lemmy.ml
      link
      fedilink
      21 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
        51 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.

        • @bastion@feddit.nl
          link
          fedilink
          1
          edit-2
          29 days ago

          capability is fine. Conflation is stupid. You can also use code to erase itself, but thinking that’s a good idea is generally wrong. But to remove that, you also remove the general ability to erase files.

        • @kchr@lemmy.sdf.org
          link
          fedilink
          130 days ago

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

    • @peereboominc@lemm.ee
      link
      fedilink
      English
      21 month ago

      Some languages use the comments to generate documentation. Something like

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