WIP: Add a script to collect system information when Blender isn't opening #122191

Draft
Alaska wants to merge 6 commits from Alaska/blender:information-collections-script into main

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.
Member

This pull request adds a python script that can collect some of the
information necessary to fill out a bug report.
The primary use case is to help users collect system information for
a bug report in the case that Blender can't open.

CMD and sh files are included to help users use the Python script.


TODO:

  • Figure out how to present this system information to the user
    • Just print the system information to terminal?
    • Print the bug report URL?
    • Automatically open the bug report URL?
  • See if GPU information collection can be added
  • Decide on what to do if the script fails (E.g. It can't extract the relevant information from blender --version)
  • Make the sh files executable (chmod +x stuff)
  • General feedback
This pull request adds a python script that can collect some of the information necessary to fill out a bug report. The primary use case is to help users collect system information for a bug report in the case that Blender can't open. `CMD` and `sh` files are included to help users use the Python script. --- TODO: - [ ] Figure out how to present this system information to the user - Just print the system information to terminal? - Print the bug report URL? - Automatically open the bug report URL? - [ ] See if GPU information collection can be added - [ ] Decide on what to do if the script fails (E.g. It can't extract the relevant information from `blender --version`) - [ ] Make the sh files executable (`chmod +x` stuff) - [ ] General feedback
Alaska added the
Module
Triaging
label 2024-05-24 09:39:09 +02:00
Alaska added this to the Triaging project 2024-05-24 09:39:24 +02:00
Alaska changed title from WIP: Add script to collect system information when Blender isn't opening to WIP: Add a script to collect system information when Blender isn't opening 2024-05-24 09:42:01 +02:00
Alaska force-pushed information-collections-script from c034a1d5b0 to 5911c3f8ae 2024-05-24 09:47:38 +02:00 Compare
Alaska added 1 commit 2024-05-28 05:30:31 +02:00

It is generally good direction. The main feedback I have is that we should not be using as bare shell as possible, without requirement of having bash, as it might not be installed on the system. The only dependency to bash seems to be for detecting the script directory. I had something like this working in the past. Not sure if it can be simplified nowadays.

And another thing is the use of os.path. In the modern Python pathutil.Path is much more preferred.

It is generally good direction. The main feedback I have is that we should not be using as bare shell as possible, without requirement of having bash, as it might not be installed on the system. The only dependency to bash seems to be for detecting the script directory. I had something [like this](https://projects.blender.org/archive/blender-benchmark-bundle/src/branch/master/run.sh#L93) working in the past. Not sure if it can be simplified nowadays. And another thing is the use of `os.path`. In the modern Python `pathutil.Path` is much more preferred.
Author
Member

we should not be using as bare shell as possible, without requirement of having bash

I assume you mean we should be using as bare shell as possible.

And another thing is the use of os.path. In the modern Python pathutil.Path is much more preferred.

I assume you mean pathlib.path. pathutil isn't bundled with the Python shipped with Blender.

> we should not be using as bare shell as possible, without requirement of having bash I assume you mean we **should** be using as bare shell as possible. > And another thing is the use of `os.path`. In the modern Python `pathutil.Path` is much more preferred. I assume you mean `pathlib.path`. pathutil isn't bundled with the Python shipped with Blender.
Alaska added 3 commits 2024-05-31 08:09:18 +02:00
Alaska added 1 commit 2024-05-31 15:07:00 +02:00
Author
Member

I'm not sure who best to ask these questions. So if you know the right person, please tag them.


One thing that has meant this script is WIP is I haven't decided the best way to present the output of the script to the user. The two main ones I'm considering are:

  1. The script automatically opens the bug report page, prefilling it with the information colllected by the script.
  2. The relevant information is printed to the terminal and the user has to copy it into the bug report form.

Automatically open bug report page

Pro:
It's simple and all the information is prefilled

Con:
GPU information is missing, users may not notice that it's missing because they assume the report is pre-filled, and thus not provide this potentially important piece of information.

Print information to terminal

Pro:
We can tell the user that the GPU information is missing and direct them to a guide on how to collect that information. For example:

System Information
Operating System: Windows ...
Graphics Card: Please follow the guide detailed in ...
Blender Version: Blender 4.2 ...

Con:
Extra steps to fill out a report


Which approach do people prefer. We could go with a hybrid appraoch. Automatically open the bug report page, but put the Please follow the guide detailed in ... part in the GPU section.

If anyone knows of a way that Python could collet GPU information automatically without relying on the GPU module found in Belnder, that would also be great.


CC @lichtwerk just so you don't miss this.

I'm not sure who best to ask these questions. So if you know the right person, please tag them. --- One thing that has meant this script is WIP is I haven't decided the best way to present the output of the script to the user. The two main ones I'm considering are: 1. The script automatically opens the bug report page, prefilling it with the information colllected by the script. 2. The relevant information is printed to the terminal and the user has to copy it into the bug report form. ### Automatically open bug report page **Pro:** It's simple and all the information is prefilled **Con:** GPU information is missing, users may not notice that it's missing because they assume the report is pre-filled, and thus not provide this potentially important piece of information. ### Print information to terminal **Pro:** We can tell the user that the GPU information is missing and direct them to a [guide](https://projects.blender.org/blender/blender-developer-docs/pulls/58) on how to collect that information. For example: ``` System Information Operating System: Windows ... Graphics Card: Please follow the guide detailed in ... Blender Version: Blender 4.2 ... ``` **Con:** Extra steps to fill out a report --- Which approach do people prefer. We could go with a hybrid appraoch. Automatically open the bug report page, but put the `Please follow the guide detailed in ...` part in the GPU section. If anyone knows of a way that Python could collet GPU information automatically without relying on the GPU module found in Belnder, that would also be great. --- CC @lichtwerk just so you don't miss this.
This pull request is marked as a work in progress.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u information-collections-script:Alaska-information-collections-script
git checkout Alaska-information-collections-script
Sign in to join this conversation.
No reviewers
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset System
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Asset Browser Project
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#122191
No description provided.