openai / openai-cookbook - Source Code Overview

Source Code Analysis Scope

Files includes and excluded from analyses

txt

jsonl

mdx

tex

mjs

17 extensions are included in analyses: ipynb, json, txt, md, py, js, yaml, ts, jsonl, tsx, gitignore, mdx, scss, tex, css, mjs, html
7 criteria are used to exclude files from analysis:

exclude files with path like ".*/(3rd|[Tt]hird)[-_]?[Pp]arty/.*" (Dependencies) (8 files).
exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (17 files).
exclude files with path like ".*/dist/.*" (Distributions) (7 files).
exclude files with path like ".*\.d\.ts" (Typescript definition files) (1 file).
exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (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) (0 files).

The source code folder contains 506 files:

365 files are included in analyses.
141 files are excluded from analyses:

Explore all 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.

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.

2 files

363 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

The following criteria are used to filter files:

files with paths like ".*".

2 files match defined criteria (1,983 LOC, 100.0% vs. main code). All matches are in *.yaml files.

Other Code

jsonl

txt

mdx

mjs

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*/[Ee]xamples/.*".
files with paths like ".*[.]md".
files with paths like ".*[.]json".
files with paths like ".*[.]txt".
files with paths like ".*/[.]gitignore".
files with paths like ".*/README[.][a-z0-9]+".
files with paths like ".*[.]mdx".

363 files match defined criteria (114,842 LOC, 5791.3% vs. main code):

108 *.ipynb files (74,235 LOC)
100 *.json files (12,597 LOC)
3 *.jsonl files (10,500 LOC)
65 *.txt files (8,784 LOC)
33 *.md files (3,914 LOC)
13 *.js files (1,648 LOC)
20 *.py files (1,295 LOC)
4 *.mdx files (823 LOC)
6 *.tsx files (497 LOC)
4 *.scss files (302 LOC)
2 *.ts files (111 LOC)
2 *.yaml files (55 LOC)
1 *.mjs files (33 LOC)
1 *.html files (28 LOC)
1 *.css files (20 LOC)

" *.ipynb" is biggest, containing 64.64% of LOC.
" *.css" is smallest, containing 0.02% of LOC.

Analyzers

Info about analyzers used for source code examinations.

*.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

2025-05-04 14:10