com.facebook.buck.parser

Class PythonDslProjectBuildFileParser

java.lang.Object

com.facebook.buck.parser.PythonDslProjectBuildFileParser

All Implemented Interfaces:

FileParser<BuildFileManifest>, ProjectBuildFileParser, AutoCloseable

public class PythonDslProjectBuildFileParser
extends Object
implements ProjectBuildFileParser

Delegates to buck.py for parsing of buck build files. Constructed on demand for the parsing phase and must be closed afterward to free up resources.

Constructor Summary

Constructors

Constructor and Description
PythonDslProjectBuildFileParser(ProjectBuildFileParserOptions options, TypeCoercerFactory typeCoercerFactory, com.google.common.collect.ImmutableMap<String,String> environment, BuckEventBus buckEventBus, ProcessExecutor processExecutor, Optional<AtomicLong> processedBytes, Optional<UserDefinedRuleLoader> userDefinedRulesParser)

Method Summary

Modifier and Type	Method and Description
void	close()
protected BuildFileManifest	getAllRulesInternal(Path buildFile)
com.google.common.collect.ImmutableSortedSet<String>	getIncludedFiles(Path buildFile) Collects the loaded files and extensions when parsing the parseFile build spec.
BuildFileManifest	getManifest(Path buildFile) Collect all rules from a particular build file, along with meta rules about the rules, for example which build files the rules depend on.
boolean	globResultsMatchCurrentState(Path buildFile, com.google.common.collect.ImmutableList<GlobSpecWithResult> existingGlobsWithResults) Checks if existing GlobSpecs with results are the same as current state in the file system.
void	initIfNeeded() Initialization on demand moves around the performance impact of creating the Python interpreter to when parsing actually begins.
boolean	isClosed()
void	reportProfile() Reports profile information captured while parsing build files.

Methods inherited from class java.lang.Object

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

Constructor Detail

PythonDslProjectBuildFileParser

public PythonDslProjectBuildFileParser(ProjectBuildFileParserOptions options,
                                       TypeCoercerFactory typeCoercerFactory,
                                       com.google.common.collect.ImmutableMap<String,String> environment,
                                       BuckEventBus buckEventBus,
                                       ProcessExecutor processExecutor,
                                       Optional<AtomicLong> processedBytes,
                                       Optional<UserDefinedRuleLoader> userDefinedRulesParser)

Method Detail

isClosed

public boolean isClosed()

initIfNeeded

public void initIfNeeded()
                  throws IOException

Initialization on demand moves around the performance impact of creating the Python interpreter to when parsing actually begins. This makes it easier to attribute this time to the actual parse phase.

Throws:

IOException

getManifest

public BuildFileManifest getManifest(Path buildFile)
                              throws BuildFileParseException,
                                     InterruptedException

Collect all rules from a particular build file, along with meta rules about the rules, for example which build files the rules depend on.

Specified by:

getManifest in interface FileParser<BuildFileManifest>

Parameters:

buildFile - should be an absolute path to a build file. Must have rootPath as its prefix.

Throws:

BuildFileParseException

InterruptedException

getAllRulesInternal

protected BuildFileManifest getAllRulesInternal(Path buildFile)
                                         throws IOException,
                                                BuildFileParseException

Throws:

IOException

BuildFileParseException

reportProfile

public void reportProfile()
                   throws IOException

Description copied from interface: ProjectBuildFileParser

Reports profile information captured while parsing build files.

Specified by:

reportProfile in interface ProjectBuildFileParser

Throws:

IOException

getIncludedFiles

public com.google.common.collect.ImmutableSortedSet<String> getIncludedFiles(Path buildFile)
                                                                      throws BuildFileParseException,
                                                                             InterruptedException

Description copied from interface: FileParser

Collects the loaded files and extensions when parsing the parseFile build spec.

Specified by:

getIncludedFiles in interface FileParser<BuildFileManifest>

Parameters:

buildFile - should be an absolute path to a file. Must have rootPath as its prefix.

Throws:

BuildFileParseException

InterruptedException

globResultsMatchCurrentState

public boolean globResultsMatchCurrentState(Path buildFile,
                                            com.google.common.collect.ImmutableList<GlobSpecWithResult> existingGlobsWithResults)

Description copied from interface: ProjectBuildFileParser

Checks if existing GlobSpecs with results are the same as current state in the file system.

Specified by:

globResultsMatchCurrentState in interface ProjectBuildFileParser

Parameters:

buildFile - the buildFile location to be used by the Globber.

existingGlobsWithResults - the existing (deserialized) GlobSpecWithResult to check the file system state against.

Returns:

true if glob expansion produces results matching previously recorded ones, false otherwise.

close

public void close()
           throws BuildFileParseException,
                  InterruptedException,
                  IOException

Specified by:

close in interface FileParser<BuildFileManifest>

Specified by:

close in interface AutoCloseable

Throws:

BuildFileParseException

InterruptedException

IOException