Package org.machanism.machai.gw.reviewer

Class PythonReviewer

java.lang.Object

org.machanism.machai.gw.reviewer.PythonReviewer

All Implemented Interfaces:

Reviewer

public class PythonReviewer
extends Object
implements Reviewer

Reviewer implementation for Python source files (.py).

Extracts guidance information or comments annotated with the FileProcessor.GUIDANCE_TAG_NAME for documentation input processing, supporting Python file comment conventions.

Constructor Summary

Constructors

Constructor	Description
PythonReviewer()

Method Summary

Modifier and Type	Method	Description
String[]	getSupportedFileExtentions()	Returns the file extensions supported by this reviewer.
String	perform(File projectDir, File guidancesFile)	Performs analysis on the specified Python source file, extracting documentation guidance if marked with the appropriate tag.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.machanism.machai.gw.reviewer.Reviewer

setDirGuidanceMap

Constructor Details

PythonReviewer

public PythonReviewer()

Method Details

getSupportedFileExtentions

public String[] getSupportedFileExtentions()

Returns the file extensions supported by this reviewer. This reviewer handles files with the 'py' extension.

Specified by:

getSupportedFileExtentions in interface Reviewer

Returns:

an array of supported file extension strings

perform

public String perform(File projectDir,
 File guidancesFile)
               throws IOException

Performs analysis on the specified Python source file, extracting documentation guidance if marked with the appropriate tag.

Specified by:

perform in interface Reviewer

Parameters:

projectDir - the root directory of the project for context

guidancesFile - the Python file to be analyzed

Returns:

formatted documentation guidance or null if none found

Throws:

IOException - if an error occurs reading the file