Package org.machanism.machai.project.layout

Class PythonProjectLayout

java.lang.Object

org.machanism.machai.project.layout.ProjectLayout

org.machanism.machai.project.layout.PythonProjectLayout

public class PythonProjectLayout
extends ProjectLayout

Project layout implementation for Python-based projects.

Determines if a directory contains a Python project using pyproject.toml and related metadata. Handles analysis of modules, sources, documents, and tests in a Python environment.

Since:

0.0.2

Author:

Viktor Tovstyi

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	PROJECT_MODEL_FILE_NAME	Conventional Python project descriptor used for project detection.

Constructor Summary

Constructors

Constructor	Description
PythonProjectLayout()	Creates a Python project layout instance.

Method Summary

Modifier and Type	Method	Description
List<String>	getDocuments()	Gets list of document directories for the Python project.
List<String>	getSources()	Gets list of source directories for the Python project.
List<String>	getTests()	Gets list of test source directories for the Python project.
static boolean	isPythonProject(File projectDir)	Checks whether the provided directory is a Python project.

Methods inherited from class org.machanism.machai.project.layout.ProjectLayout

getExcludeDirs, getModules, getParentId, getProjectDir, getProjectId, getProjectLayoutType, getProjectName, getRelativePath, getRelativePath, getRelativePath, getTempDir, isExcludedPath, listDirectories, listFiles, projectDir

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PROJECT_MODEL_FILE_NAME

private static final String PROJECT_MODEL_FILE_NAME

Conventional Python project descriptor used for project detection.

See Also:

• Constant Field Values

Constructor Details

PythonProjectLayout

public PythonProjectLayout()

Creates a Python project layout instance.

Method Details

isPythonProject

public static boolean isPythonProject(File projectDir)

Checks whether the provided directory is a Python project.

• Looks for pyproject.toml, setup.py, or setup.cfg.
• Checks for requirements.txt, Pipfile, or typical virtual environment directories.
• Examines Python file structures and project classifiers.

Parameters:

projectDir - Directory to examine for Python project indicators

Returns:

true if a Python project is detected, false otherwise

getSources

public List<String> getSources()

Gets list of source directories for the Python project.

Specified by:

getSources in class ProjectLayout

Returns:

empty list; intentionally returns a safe default until Python source discovery is implemented

getDocuments

public List<String> getDocuments()

Gets list of document directories for the Python project.

Specified by:

getDocuments in class ProjectLayout

Returns:

empty list; intentionally returns a safe default until Python documentation discovery is implemented

getTests

public List<String> getTests()

Gets list of test source directories for the Python project.

Specified by:

getTests in class ProjectLayout

Returns:

empty list; intentionally returns a safe default until Python test discovery is implemented