feat(commands): added a --json option to info and run command

[noirbizarre]

Pull Request Checklist

• A news fragment is added in news/ describing what is new.
• Test cases added for changed code.

Describe what you have changed in this PR.

This PR adds a --json option (exclusive with other options) to info and run commands in order to dump those data as JSON.

On my current pdm workspace, it give those results

pdm run --json

{
  "complete": {
    "name": "complete",
    "kind": "call",
    "help": "Create autocomplete files for bash and fish",
    "args": "tasks.complete:main"
  },
  "doc": {
    "name": "doc",
    "kind": "shell",
    "help": "Start the dev server for doc preview",
    "args": "cd docs && mkdocs serve"
  },
  "lint": {
    "name": "lint",
    "kind": "cmd",
    "help": "pre-commit run --all-files",
    "args": "pre-commit run --all-files"
  },
  "pre_release": {
    "name": "pre_release",
    "kind": "cmd",
    "help": "python tasks/max_versions.py",
    "args": "python tasks/max_versions.py"
  },
  "release": {
    "name": "release",
    "kind": "cmd",
    "help": "python tasks/release.py",
    "args": "python tasks/release.py"
  },
  "test": {
    "name": "test",
    "kind": "cmd",
    "help": "pytest",
    "args": "pytest"
  },
  "tox": {
    "name": "tox",
    "kind": "cmd",
    "help": "tox",
    "args": "tox"
  }
}

pdm info --json

{
  "pdm": {
    "version": "2.5.4.dev5+g8d452e0d.d20230425.editable"
  },
  "python": {
    "interpreter": "/home/noirbizarre/Workspaces/_contribs/pdm/.venv/bin/python",
    "version": "3.11",
    "markers": {
      "implementation_name": "cpython",
      "implementation_version": "3.11.3",
      "os_name": "posix",
      "platform_machine": "x86_64",
      "platform_release": "6.2.12-arch1-1",
      "platform_system": "Linux",
      "platform_version": "#1 SMP PREEMPT_DYNAMIC Thu, 20 Apr 2023 16:11:55 +0000",
      "python_full_version": "3.11.3",
      "platform_python_implementation": "CPython",
      "python_version": "3.11",
      "sys_platform": "linux"
    }
  },
  "project": {
    "root": "/home/noirbizarre/Workspaces/_contribs/pdm",
    "pypackages": "/home/noirbizarre/Workspaces/_contribs/pdm/__pypackages__/3.11"
  }
}

Use cases

Here some possible use cases:

• shell introspection using jq
• Conditional steps in CI (if command is present, then ...)
• automatic doc generation
• cross projects inventory/analysis

[frostming]

LGTM, only a small tweak, the environment markers should belong to python namespace

[noirbizarre]

Updated: the markers are now in the python object.
PR example is updated too 👆🏼

[frostming]

Sorry to miss one: pypackages should belong to project object.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.36%. Comparing base (0cf6578) to head (122b4a0).
Report is 649 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1854      +/-   ##
==========================================
+ Coverage   85.31%   85.36%   +0.04%     
==========================================
  Files          99       99              
  Lines        9037     9066      +29     
  Branches     1955     1960       +5     
==========================================
+ Hits         7710     7739      +29     
  Misses        896      896              
  Partials      431      431              

Flag	Coverage Δ
unittests	85.17% <100.00%> (+0.04%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[noirbizarre]

No prb, it is updated 👍🏼