openai / spinningup Source Code Overview |
Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 11 extensions are included in analyses: py, svg, rst, txt, xml, yaml, css, gitignore, bat, sh, md
- 4 criteria are used to exclude files from analysis:
- exclude files with path like ".*/docs/.*" (Documentation) (77 files).
- exclude files with path like ".*/docs?/_?(build|themes?|templates?|static)/.*" (Sphinx) (0 files).
- exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
- exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
- The source code folder contains 182 files:
- 70 files are included in analyses.
- 112 files are excluded from analyses:
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.
- The main category contains all manually created source code files that are being used in the production.
- Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
- Test source code files are used only for testing of the product. These files are normally not deployed to production.
- Build and deployment source code files are used to configure or support build and deployment process.
- Generated source code files are automatically generated files that have not been manually changed after generation.
- While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
- Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Build and Deployment Code
Source code used to configure or support build and deployment process.
- The following criteria are used to filter files:
- files with paths like ".*/setup[.]py".
- files with paths like ".*[.]bat".
- files with paths like ".*[.]sh".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- 3 files match defined criteria (73 LOC, 1.9% vs. main code):
- 1 *.py files (32 LOC)
- 1 *.sh files (31 LOC)
- 1 *.gitignore files (10 LOC)
- " *.py" is biggest, containing 43.84% of LOC.
- " *.gitignore" is smallest, containing 13.7% of LOC.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
- files with paths like ".*[.]svg".
- files with paths like ".*[.]txt".
- files with paths like ".*/[Ee]xamples/.*".
- 8 files match defined criteria (423 LOC, 10.9% vs. main code):
- 7 *.py files (401 LOC)
- 1 *.md files (22 LOC)
- " *.py" is biggest, containing 94.8% of LOC.
- " *.md" is smallest, containing 5.2% of LOC.
Analyzers
Info about analyzers used for source code examinations.
- *.py files are analyzed with PythonAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
- Unit size analysis
- Conditional complexity analysis
- Basic heuristic dependency analysis
2026-06-24 10:32