Source Code Analysis Scope
Files includes and excluded from analyses
in

scoping details...
  • 9 extensions are included in analyses: py, rst, txt, bat, in, gitignore, md, yml, toml
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (11 files).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
    • 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) (1 file).
    • exclude files with path like ".*/_sokrates/.*" (Sokrates files) (0 files).
    • exclude files with path like ".*/_sokrates_landscape/.*" (Sokrates landscape files) (0 files).
    • exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (0 files).
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.
main8994 LOC (73%) 34 files
test2607 LOC (21%) 20 files
generated0 LOC (0%) 0 files
build and deployment197 LOC (1%) 3 files
other445 LOC (3%) 7 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
in
Explore:   circles  |  sunburst

py8993 LOC (99%) 33 files
in1 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 34 files match defined criteria (8,994 LOC, 100.0% vs. main code):
    • 33 py files (8,993 LOC)
    • 1 in files (1 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

py2607 LOC (100%) 20 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
  • 20 files match defined criteria (2,607 LOC, 29.0% vs. main code). All matches are in py files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

yaml104 LOC (52%) 1 file
toml75 LOC (38%) 1 file
gitignore18 LOC (9%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/pyproject[.]toml".
    • files with paths like ".*[.]bat".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
  • 3 files match defined criteria (197 LOC, 2.2% vs. main code):
    • 1 yaml files (104 LOC)
    • 1 toml files (75 LOC)
    • 1 gitignore files (18 LOC)
Other Code
Explore:   circles  |  sunburst

py386 LOC (86%) 6 files
md59 LOC (13%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]txt".
  • 7 files match defined criteria (445 LOC, 4.9% vs. main code):
    • 6 py files (386 LOC)
    • 1 md files (59 LOC)
About This Analysis
learn more about scopes (main, test, generated, build, 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.

learn more about used code analyzers...
  • *.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
  • *.in files are analyzed with RustAnalyzer:
    • 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
    • No dependency analysis