Skip to content

2022 11 28 defaults #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: base-sha/125b313bd333a294888cfa7a463a8819f109b9a7
Choose a base branch
from
Open

2022 11 28 defaults #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
843e2b6
Show default values for kwonly arguments in help text. Includes test.
dbieber Nov 28, 2022
c4e5575
Make Python versions more specific
dbieber Nov 28, 2022
59c0185
Python setup version
dbieber Nov 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions fire/helptext.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,8 @@ def _GetArgDefault(flag, spec):
for arg, default in zip(args_with_defaults, spec.defaults):
if arg == flag:
return repr(default)
if flag in spec.kwonlydefaults:
return repr(spec.kwonlydefaults[flag])
Comment on lines +527 to +528
Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (bug_risk): Consider handling the case where kwonlydefaults is None.

If spec.kwonlydefaults is None, this code will raise an AttributeError. It might be safer to check if kwonlydefaults is not None before checking if flag is in kwonlydefaults.

Suggested change
if flag in spec.kwonlydefaults:
return repr(spec.kwonlydefaults[flag])
if spec.kwonlydefaults and flag in spec.kwonlydefaults:
return repr(spec.kwonlydefaults[flag])

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this comment correct?

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this comment helpful?

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the comment type correct?

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the comment area correct?

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What type of LLM test could this comment become?

  • 👍 - this comment is really good/important and we should always make it
  • 👎 - this comment is really bad and we should never make it
  • no reaction - don't turn this comment into an LLM test

return ''


Expand Down
12 changes: 12 additions & 0 deletions fire/helptext_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,18 @@ def testHelpTextKeywordOnlyArgumentsWithoutDefault(self):
self.assertIn('NAME\n double', output)
self.assertIn('FLAGS\n --count=COUNT (required)', output)

@testutils.skipIf(
six.PY2,
'Python 2 does not support required name-only arguments.')
def testHelpTextFunctionMixedDefaults(self):
component = tc.py3.HelpTextComponent().identity
t = trace.FireTrace(component, name='FunctionMixedDefaults')
output = helptext.HelpText(component, trace=t)
self.assertIn('NAME\n FunctionMixedDefaults', output)
self.assertIn('FunctionMixedDefaults <flags>', output)
self.assertIn('--alpha=ALPHA (required)', output)
Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (testing): Consider adding assertions for edge cases in testHelpTextFunctionMixedDefaults.

The test currently checks for the presence of flags with and without defaults. It would be beneficial to include assertions for edge cases such as missing flags or incorrect default values to ensure robustness.

Suggested change
self.assertIn('--alpha=ALPHA (required)', output)
self.assertIn('--alpha=ALPHA (required)', output)
self.assertIn('--beta=BETA\n Default: \'0\'', output)
self.assertNotIn('--gamma=GAMMA', output)
self.assertIn('--beta=BETA\n Default: \'1\'', output, msg="Check incorrect default for beta")

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this comment correct?

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this comment helpful?

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the comment type correct?

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the comment area correct?

Copy link

@SourceryAI SourceryAI May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What type of LLM test could this comment become?

  • 👍 - this comment is really good/important and we should always make it
  • 👎 - this comment is really bad and we should never make it
  • no reaction - don't turn this comment into an LLM test

self.assertIn('--beta=BETA\n Default: \'0\'', output)

def testHelpScreen(self):
component = tc.ClassWithDocstring()
t = trace.FireTrace(component, name='ClassWithDocstring')
Expand Down