Params should render themselves #16
Conversation
Extract helper methods for formatting the signature and parameter sections, and clean up the remaining function body.
Co-authored-by: Alex Waygood <[email protected]>
This reverts commit 1d244dc.
Co-authored-by: Alex Waygood <[email protected]>
Previously, parameter docstring rendering was done in the DSLParser class. Instead, let the Parameter class render themselves.
|
I think this is pretty neat, @AlexWaygood: fa29529 |
| else: | ||
| return f'"argument {i}"' | ||
|
|
||
| def render_docstring(self) -> str: |
There was a problem hiding this comment.
This may be a good case for -> str | None
There was a problem hiding this comment.
OTOH, I'm not sure it matters that much.
There was a problem hiding this comment.
This looks good, but I think we should go further. format_docstring() itself also looks like it should probably be a method on Function objects rather than a method on the DSLParser. It doesn't reference any state on the DSLParser, except for attributes on self.function. (This has implications for python#107623!)
So, instead of self.function.docstring = self.format_docstring() in the DSLParser.do_post_block_processing_cleanup() method, it would just be self.function.format_docstring() -- the Function object would know how to format its own docstring, instead of the DSLParser object reaching in and modifying the state of the Function object.
Yes, that was my plan. I figured applying this change to Parameter was a nice start, since it makes for a small proof-of-concept PR.
I'm not sure yet how to refactor the generation phase. I have a proof-of-concept branch locally (I might have pushed it here, I don't remember, and I don't intend to find out before finishing writing this :) ) where I ended up with something like this in template_dict['docstring'] = f.render_docstring() |
|
See pythongh-107790 |
Based off of python#107623