{namespace python_library}

{template .soyweb}

{call buck.page}

{param title: 'python_library()' /}

{param navid: 'rule_python_library' /}

{param prettify: true /}

{param description}

A python_library() rule is used to group Python source files and

resources.

{/param}

{param content}

{call buck.rule}

{param status: 'UNFROZEN' /}

{param overview}

A <code>python_library()</code> rule is used to group together Python sources

and resources to be packaged into a top-level {call buck.python_binary /} rule.

{/param}

{param args}

{call buck.arg}

{param name: 'name' /}

{param desc}

The name of the rule.

{/param}

{/call}

{call python_common.srcs_arg /}

{call python_common.platform_srcs_arg /}

{call python_common.resources_arg /}

{call python_common.platform_resources_arg /}

{call python_common.base_module_arg /}

{call buck.arg}

{param name: 'deps' /}

{param default : '[]' /}

{param desc}

Other <code>python_library()</code> rules which lists <code>srcs</code> from

which this rule imports modules.

{/param}

{/call}

{call python_common.exclude_deps_from_merged_linking_arg /}

{/param} // close args

{param examples}

{literal}<pre class="prettyprint lang-py">

# A rule that includes a single .py file.

python_library(

name = 'fileutil',

srcs = ['fileutil.py'],

deps = [

'//third_party/python-magic:python-magic',

],

)

# A rule that uses glob() to include all sources in the directory which the

# rule is defined. It also lists a resource file that gets packaged with

# the sources in this rule.

python_library(

name = 'testutil',

srcs = glob(['testutil/**/*.py']),

resources = [

'testdata.dat',

],

)

</pre>{/literal}

<p>

Here is an example of using the `platform_srcs` and `platform_resources`

parameters to pull in sources/resources only when building for a specific

Python platform:

</p>

{literal}<pre class="prettyprint lang-ini">

; .buckconfig

[python#py2]

interpreter = /usr/bin/python2.7

[python#py3]

interpreter = /usr/bin/python3.4

</pre>{/literal}

{literal}<pre class="prettyprint lang-py">

# BUCK

python_library(

name = 'utils',

platform_srcs = [

('py2', ['foo.py']),

('py3', ['bar.py']),

],

platform_resources = [

('py2', ['foo.dat']),

('py3', ['bar.dat']),

],

)

</pre>{/literal}

{/param}

{/call} // close buck.rule

{/param}

{/call}

{/template}