Skip to content
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.

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

Exit gracefully when file not found #53

Closed
rnjudge opened this issue Jan 24, 2023 · 1 comment · Fixed by #55
Closed

Exit gracefully when file not found #53

rnjudge opened this issue Jan 24, 2023 · 1 comment · Fixed by #55
Assignees
Labels
enhancement New feature or request P1 Medium priority

Comments

@rnjudge
Copy link

rnjudge commented Jan 24, 2023

When I was running the tool I accidentally provided a file to it that did not exist (fat finger typo). The tool gave me a confusing UnboundLocalError message that might be confusing for users not familiar with reading Python tracebacks. Suggestion for the tool to exit gracefully if a non-existent file is supplied by providing a more clear error message.

Currently:

(ternenv) rose@rose-vm:~/ternenv/ntia-conformance-checker/ntia_conformance_checker$ python3 main.py -v --file dne.spdx
ERROR:root:Filename dne.spdx not found.
ERROR:root:Document cannot be parsed: [Errno 2] No such file or directory: 'dne.spdx'
Traceback (most recent call last):
  File "/home/rose/ternenv/ntia-conformance-checker/ntia_conformance_checker/main.py", line 51, in <module>
    main()  # pylint: disable=no-value-for-parameter
  File "/home/rose/ternenv/lib/python3.10/site-packages/click/core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
  File "/home/rose/ternenv/lib/python3.10/site-packages/click/core.py", line 1055, in main
    rv = self.invoke(ctx)
  File "/home/rose/ternenv/lib/python3.10/site-packages/click/core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/rose/ternenv/lib/python3.10/site-packages/click/core.py", line 760, in invoke
    return __callback(*args, **kwargs)
  File "/home/rose/ternenv/ntia-conformance-checker/ntia_conformance_checker/main.py", line 36, in main
    sbom = sbom_checker.SbomChecker(file)
  File "/home/rose/ternenv/ntia-conformance-checker/ntia_conformance_checker/sbom_checker.py", line 17, in __init__
    self.doc = self.parse_file()
  File "/home/rose/ternenv/ntia-conformance-checker/ntia_conformance_checker/sbom_checker.py", line 42, in parse_file
    return doc
UnboundLocalError: local variable 'doc' referenced before assignment

Could be improved to something like:

(ternenv) rose@rose-vm:~/ternenv/ntia-conformance-checker/ntia_conformance_checker$ python3 main.py -v --file dne.spdx
Warning: file 'dne.spdx' not found.
@jspeed-meyers
Copy link
Collaborator

@rnjudge, great call!

@jspeed-meyers jspeed-meyers added enhancement New feature or request P1 Medium priority labels Jan 25, 2023
@jspeed-meyers jspeed-meyers self-assigned this Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P1 Medium priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants