anthropics / prompt-eng-interactive-tutorial 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
- 6 extensions are included in analyses: ipynb, md, py, txt, gitignore, yaml
- 2 criteria are used to exclude files from analysis:
- 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 52 files:
- 43 files are included in analyses.
- 9 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.
- The following criteria are used to filter files:
- files with paths like ".*".
- 38 files match defined criteria (15,565 LOC, 100.0% vs. main code):
- 35 *.ipynb files (15,392 LOC)
- 3 *.py files (173 LOC)
- " *.ipynb" is biggest, containing 98.89% of LOC.
- " *.py" is smallest, containing 1.11% of LOC.
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 ".*/requirements[a-zA-Z0-9._-]*[.]txt".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- 1 file matches defined criteria (1 LOC, 0.0% vs. main code). All matches are in *.gitignore files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*[.]txt".
- files with paths like ".*/README[.][a-z0-9]+".
- 4 files match defined criteria (116 LOC, 0.7% vs. main code):
- 3 *.md files (111 LOC)
- 1 *.txt files (5 LOC)
- " *.md" is biggest, containing 95.69% of LOC.
- " *.txt" is smallest, containing 4.31% of LOC.
Analyzers
Info about analyzers used for source code examinations.
- *.ipynb files are analyzed with DefaultLanguageAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.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:44