guardian/yacht-charter-python-library
Code Volume
Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses

scoping details...
  • 4 extensions are included in analyses: py, gitignore, md, toml
  • 4 criteria are used to exclude files from analysis:
    • 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 ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (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.
main52 LOC (45%) 2 files
test25 LOC (21%) 1 file
generated0 LOC (0%) 0 files
build and deployment36 LOC (31%) 3 files
other2 LOC (1%) 1 file
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

py52 LOC (100%) 2 files

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

py25 LOC (100%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/test[.].*".
  • 1 file matches defined criteria (25 LOC, 48.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.
Explore:   circles  |  sunburst

py21 LOC (58%) 1 file
gitignore9 LOC (25%) 1 file
toml6 LOC (16%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/pyproject[.]toml".
    • files with paths like ".*/setup[.]py".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 3 files match defined criteria (36 LOC, 69.2% vs. main code):
    • 1 py files (21 LOC)
    • 1 gitignore files (9 LOC)
    • 1 toml files (6 LOC)
Other Code
Explore:   circles  |  sunburst

md2 LOC (100%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
  • 1 file matches defined criteria (2 LOC, 3.8% 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