Source Code Analysis Scope
Files includes and excluded from analyses
ini

scoping details...
  • 14 extensions are included in analyses: py, rst, yml, ipynb, txt, md, yaml, sh, toml, json, ini, svg, gitignore, dockerignore
  • 8 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/testdata/.*" (Test data) (2 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (35 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.
main21488 LOC (37%) 124 files
test34610 LOC (60%) 66 files
generated0 LOC (0%) 0 files
build and deployment765 LOC (1%) 13 files
other551 LOC (<1%) 10 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst

py21380 LOC (99%) 119 files
yaml108 LOC (<1%) 5 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 124 files match defined criteria (21,488 LOC, 100.0% vs. main code):
    • 119 py files (21,380 LOC)
    • 5 yaml files (108 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

py34450 LOC (99%) 64 files
yaml124 LOC (<1%) 1 file
sh36 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*[-]tests/.*".
  • 66 files match defined criteria (34,610 LOC, 161.1% vs. main code):
    • 64 py files (34,450 LOC)
    • 1 yaml files (124 LOC)
    • 1 sh files (36 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

yaml441 LOC (57%) 8 files
sh179 LOC (23%) 2 files
toml113 LOC (14%) 1 file
gitignore28 LOC (3%) 1 file
dockerignore4 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]sh".
    • files with paths like ".*/requirements[a-zA-Z0-9._-]*[.]txt".
    • files with paths like ".*/pyproject[.]toml".
    • files with paths like ".*/docker[-]compose[.]yml".
    • files with paths like ".*/[.]dockerignore".
    • files with paths like "(.*/)?[.]dockerignore".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like ".*/[.]github/actions/.*[.]ya?ml".
    • files with paths like ".*/action[.]ya?ml".
  • 13 files match defined criteria (765 LOC, 3.6% vs. main code):
    • 8 yaml files (441 LOC)
    • 2 sh files (179 LOC)
    • 1 toml files (113 LOC)
    • 1 gitignore files (28 LOC)
    • 1 dockerignore files (4 LOC)
Other Code
ini
Explore:   circles  |  sunburst

md271 LOC (49%) 5 files
txt165 LOC (29%) 3 files
json92 LOC (16%) 1 file
ini23 LOC (4%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]ini".
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*/[Ee]xamples/.*".
  • 10 files match defined criteria (551 LOC, 2.6% vs. main code):
    • 5 md files (271 LOC)
    • 3 txt files (165 LOC)
    • 1 json files (92 LOC)
    • 1 ini files (23 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
  • *.yaml files are analyzed with YamlAnalyzer:
    • 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)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis