pcdshub / pcdshub/hutch-python

Loading Standards

Open
#127 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
18
Avg merge
7d 9h
Merged PRs (30d)
1

Description

Expected Behavior

Have consistent rules for where errors are catched and how they are handled during the load process.

Current Behavior

Often safe_load is applied in arbitrary places in the code wherever the developer deemed appropriate.

Possible Solution

  • Never raise an exception that bubbles up past load: always finish the load and load "something"
  • Use safe_load universally in load_conf.py and nowhere else
  • Have submodules raise errors when something bad happens
  • Log specific "expected fails" inside of submodules without raising
  • Log special errors that need more clarifications inside of submodules
  • Only show tracebacks in user code

Context

#126

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading load_conf.py and the submodules involved in the load process, then review the related context in issue #126. Map where safe_load, exceptions, and traceback logging currently occur. Done means the loading and error-handling rules are consistently applied as listed in the proposed solution.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.