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

Provide pyhf debug utility that prints debugging information for user issues #1580

Open
kratsg opened this issue Sep 2, 2021 · 2 comments · May be fixed by #2129
Open

Provide pyhf debug utility that prints debugging information for user issues #1580

kratsg opened this issue Sep 2, 2021 · 2 comments · May be fixed by #2129
Assignees
Labels
CLI Affects the CLI API feat/enhancement New feature or request

Comments

@kratsg
Copy link
Contributor

kratsg commented Sep 2, 2021

During this portion, I wonder if we should provide a pyhf debug or similar CLI so users can copy/paste that output entirely.

Originally posted by @kratsg in #1576 (comment)

@matthewfeickert matthewfeickert added CLI Affects the CLI API feat/enhancement New feature or request labels Sep 2, 2021
@matthewfeickert matthewfeickert added this to To do in v0.7.0 via automation Sep 2, 2021
@matthewfeickert matthewfeickert removed this from To do in v0.7.0 Nov 12, 2021
@matthewfeickert matthewfeickert added this to To do in v0.7.1 via automation Nov 12, 2021
@matthewfeickert
Copy link
Member

@kratsg while I know this is quite old, are you able to elaborate more on what you envision the scope of this being? Can you give an example use case?

@matthewfeickert
Copy link
Member

matthewfeickert commented Mar 2, 2023

Ah looking at this more from the context of PR #1576, I think the idea was to give people a CLI to get all the information from the "OS / Environment" section of the bug report template:

OS / Environment

Provide information on your operating system. Something like the output of cat /etc/os-release on Linux or system_profiler -detailLevel mini SPSoftwareDataType on macOS.

# Linux
$ cat /etc/os-release
NAME="Ubuntu"
VERSION="20.04.2 LTS (Focal Fossa)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 20.04.2 LTS"
VERSION_ID="20.04"
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
VERSION_CODENAME=focal
UBUNTU_CODENAME=focal
# macOS
$ system_profiler -detailLevel mini SPSoftwareDataType | head -n 6
Software:

    System Software Overview:

      System Version: macOS 10.15.7 (19H1323)
      Kernel Version: Darwin 19.6.0

So that using

$ pyhf debug

would produce something like the above without the user needing to know what commands to run (also producing consistent output).

Though maybe it might make more sense to have a

$ pyhf utils debug

CLI API.

@matthewfeickert matthewfeickert self-assigned this Mar 3, 2023
@matthewfeickert matthewfeickert removed this from To do in v0.7.1 Mar 3, 2023
@matthewfeickert matthewfeickert linked a pull request Mar 6, 2023 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLI Affects the CLI API feat/enhancement New feature or request
Projects
Status: To do
Development

Successfully merging a pull request may close this issue.

2 participants