Source Code Analysis Scope
Files includes and excluded from analyses
cfg

scoping details...
  • 8 extensions are included in analyses: py, md, txt, htm, cfg, gitignore, yml, ipynb
  • 6 criteria are used to exclude files from analysis:
    • 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.
main16381 LOC (91%) 124 files
test1002 LOC (5%) 26 files
generated0 LOC (0%) 0 files
build and deployment93 LOC (<1%) 4 files
other333 LOC (1%) 12 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

py10815 LOC (66%) 123 files
htm5566 LOC (33%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 124 files match defined criteria (16,381 LOC, 100.0% vs. main code):
    • 123 py files (10,815 LOC)
    • 1 htm files (5,566 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

py1002 LOC (100%) 26 files

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

py51 LOC (54%) 1 file
gitignore25 LOC (26%) 1 file
yaml11 LOC (11%) 1 file
cfg6 LOC (6%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/setup[.]py".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/setup[.]cfg".
    • files with paths like ".*/[.]travis[.]yml".
  • 4 files match defined criteria (93 LOC, 0.6% vs. main code):
    • 1 py files (51 LOC)
    • 1 gitignore files (25 LOC)
    • 1 yaml files (11 LOC)
    • 1 cfg files (6 LOC)
Other Code
Explore:   circles  |  sunburst

md333 LOC (100%) 12 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
  • 12 files match defined criteria (333 LOC, 2.0% vs. main code). All matches are in md files.
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
  • *.htm files are analyzed with HtmlAnalyzer:
    • 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
    • Advanced heuristic dependency analysis