shell_builder.ShellFBCodeBuilder Class Reference

Inheritance diagram for shell_builder.ShellFBCodeBuilder:

Public Member Functions
def	workdir (self, dir)
def	run (self, shell_cmd)
def	step (self, name, actions)
def	setup (self)
def	comment (self, comment)
def	copy_local_repo (self, dir, dest_name)
def	workdir (self, dir)
def	run (self, shell_cmd)
def	step (self, name, actions)
def	setup (self)
def	comment (self, comment)
def	copy_local_repo (self, dir, dest_name)
def	workdir (self, dir)
def	run (self, shell_cmd)
def	step (self, name, actions)
def	setup (self)
def	comment (self, comment)
def	copy_local_repo (self, dir, dest_name)
def	workdir (self, dir)
def	run (self, shell_cmd)
def	step (self, name, actions)
def	setup (self)
def	comment (self, comment)
def	copy_local_repo (self, dir, dest_name)
Public Member Functions inherited from fbcode_builder.FBCodeBuilder
def	__init__ (self, kwargs)
def	__repr__ (self)
def	option (self, name, default=None)
def	has_option (self, name)
def	add_option (self, name, value)
def	render (self, steps)
def	build (self, steps)
def	setup (self)
def	diagnostics (self)
def	step (self, name, actions)
def	run (self, shell_cmd)
def	workdir (self, dir)
def	copy_local_repo (self, dir, dest_name)
def	debian_deps (self)
def	install_debian_deps (self)
def	debian_ccache_setup_steps (self)
def	github_project_workdir (self, project, path)
def	fb_github_project_workdir (self, project_and_path, github_org='facebook')
def	parallel_make (self, make_vars=None)
def	make_and_install (self, make_vars=None)
def	configure (self, name=None)
def	autoconf_install (self, name)
def	cmake_configure (self, name, cmake_path='..')
def	cmake_install (self, name, cmake_path='..')
def	fb_github_autoconf_install (self, project_and_path, github_org='facebook')
def	fb_github_cmake_install (self, project_and_path, cmake_path='..', github_org='facebook')
def	__init__ (self, kwargs)
def	__repr__ (self)
def	option (self, name, default=None)
def	has_option (self, name)
def	add_option (self, name, value)
def	render (self, steps)
def	build (self, steps)
def	setup (self)
def	diagnostics (self)
def	step (self, name, actions)
def	run (self, shell_cmd)
def	workdir (self, dir)
def	copy_local_repo (self, dir, dest_name)
def	debian_deps (self)
def	install_debian_deps (self)
def	debian_ccache_setup_steps (self)
def	github_project_workdir (self, project, path)
def	fb_github_project_workdir (self, project_and_path, github_org='facebook')
def	parallel_make (self, make_vars=None)
def	make_and_install (self, make_vars=None)
def	configure (self, name=None)
def	autoconf_install (self, name)
def	cmake_configure (self, name, cmake_path='..')
def	cmake_install (self, name, cmake_path='..')
def	fb_github_autoconf_install (self, project_and_path, github_org='facebook')
def	fb_github_cmake_install (self, project_and_path, cmake_path='..', github_org='facebook')
def	__init__ (self, kwargs)
def	__repr__ (self)
def	option (self, name, default=None)
def	has_option (self, name)
def	add_option (self, name, value)
def	render (self, steps)
def	build (self, steps)
def	setup (self)
def	diagnostics (self)
def	step (self, name, actions)
def	run (self, shell_cmd)
def	workdir (self, dir)
def	copy_local_repo (self, dir, dest_name)
def	debian_deps (self)
def	install_debian_deps (self)
def	debian_ccache_setup_steps (self)
def	github_project_workdir (self, project, path)
def	fb_github_project_workdir (self, project_and_path, github_org='facebook')
def	parallel_make (self, make_vars=None)
def	make_and_install (self, make_vars=None)
def	configure (self, name=None)
def	autoconf_install (self, name)
def	cmake_configure (self, name, cmake_path='..')
def	cmake_install (self, name, cmake_path='..')
def	fb_github_autoconf_install (self, project_and_path, github_org='facebook')
def	fb_github_cmake_install (self, project_and_path, cmake_path='..', github_org='facebook')
def	__init__ (self, kwargs)
def	__repr__ (self)
def	option (self, name, default=None)
def	has_option (self, name)
def	add_option (self, name, value)
def	render (self, steps)
def	build (self, steps)
def	setup (self)
def	diagnostics (self)
def	step (self, name, actions)
def	run (self, shell_cmd)
def	workdir (self, dir)
def	copy_local_repo (self, dir, dest_name)
def	debian_deps (self)
def	install_debian_deps (self)
def	debian_ccache_setup_steps (self)
def	github_project_workdir (self, project, path)
def	fb_github_project_workdir (self, project_and_path, github_org='facebook')
def	parallel_make (self, make_vars=None)
def	make_and_install (self, make_vars=None)
def	configure (self, name=None)
def	autoconf_install (self, name)
def	cmake_configure (self, name, cmake_path='..')
def	cmake_install (self, name, cmake_path='..')
def	fb_github_autoconf_install (self, project_and_path, github_org='facebook')
def	fb_github_cmake_install (self, project_and_path, cmake_path='..', github_org='facebook')

Private Member Functions
def	_render_impl (self, steps)
def	_render_impl (self, steps)
def	_render_impl (self, steps)
def	_render_impl (self, steps)

Additional Inherited Members
Public Attributes inherited from fbcode_builder.FBCodeBuilder
	options_used

Detailed Description

Definition at line 32 of file shell_builder.py.

Member Function Documentation

def shell_builder.ShellFBCodeBuilder._render_impl (   self,   steps  )

private

Definition at line 33 of file shell_builder.py.

References shell_quoting.raw_shell(), utils.recursively_flatten_list(), and shell_quoting.shell_join().

Referenced by shell_builder.ShellFBCodeBuilder._render_impl(), and fbcode_builder.FBCodeBuilder.render().

    def _render_impl(self, steps):
        return raw_shell(shell_join('\n', recursively_flatten_list(steps)))

def shell_builder.ShellFBCodeBuilder._render_impl (   self,   steps  )

private

Definition at line 33 of file shell_builder.py.

References shell_builder.ShellFBCodeBuilder._render_impl(), shell_quoting.raw_shell(), utils.recursively_flatten_list(), and shell_quoting.shell_join().

Referenced by fbcode_builder.FBCodeBuilder.render().

    def _render_impl(self, steps):
        return raw_shell(shell_join('\n', recursively_flatten_list(steps)))

def shell_builder.ShellFBCodeBuilder._render_impl (   self,   steps  )

private

Definition at line 33 of file shell_builder.py.

References shell_builder.ShellFBCodeBuilder._render_impl(), shell_quoting.raw_shell(), utils.recursively_flatten_list(), and shell_quoting.shell_join().

Referenced by fbcode_builder.FBCodeBuilder.render().

    def _render_impl(self, steps):
        return raw_shell(shell_join('\n', recursively_flatten_list(steps)))

def shell_builder.ShellFBCodeBuilder._render_impl (   self,   steps  )

private

Definition at line 33 of file shell_builder.py.

References shell_builder.ShellFBCodeBuilder._render_impl(), shell_quoting.raw_shell(), utils.recursively_flatten_list(), and shell_quoting.shell_join().

Referenced by fbcode_builder.FBCodeBuilder.render().

    def _render_impl(self, steps):
        return raw_shell(shell_join('\n', recursively_flatten_list(steps)))

def shell_builder.ShellFBCodeBuilder.comment	(		self,
			comment
	)

Definition at line 66 of file shell_builder.py.

References shell_builder.ShellFBCodeBuilder.comment(), and shell_quoting.shell_comment().

Referenced by fbcode_builder.FBCodeBuilder.diagnostics().

    def comment(self, comment):
        return shell_comment(comment)

def shell_builder.ShellFBCodeBuilder.comment	(		self,
			comment
	)

Definition at line 66 of file shell_builder.py.

References shell_builder.ShellFBCodeBuilder.comment(), and shell_quoting.shell_comment().

Referenced by fbcode_builder.FBCodeBuilder.diagnostics().

    def comment(self, comment):
        return shell_comment(comment)

def shell_builder.ShellFBCodeBuilder.comment	(		self,
			comment
	)

Definition at line 66 of file shell_builder.py.

References shell_builder.ShellFBCodeBuilder.comment(), and shell_quoting.shell_comment().

Referenced by fbcode_builder.FBCodeBuilder.diagnostics().

    def comment(self, comment):
        return shell_comment(comment)

def shell_builder.ShellFBCodeBuilder.comment	(		self,
			comment
	)

Definition at line 66 of file shell_builder.py.

References shell_quoting.shell_comment().

Referenced by shell_builder.ShellFBCodeBuilder.comment(), and fbcode_builder.FBCodeBuilder.diagnostics().

    def comment(self, comment):
        return shell_comment(comment)

def shell_builder.ShellFBCodeBuilder.copy_local_repo	(		self,
			dir,
			dest_name
	)

Definition at line 69 of file shell_builder.py.

References utils.build_fbcode_builder_config(), shell_builder.ShellFBCodeBuilder.copy_local_repo(), shell_builder.find_project_root(), folly.format(), shell_builder.make_steps, shell_builder.persistent_temp_dir(), utils.read_fbcode_builder_config(), and replace().

    def copy_local_repo(self, dir, dest_name):
        return [
            ShellQuoted('cp -r {dir} {dest_name}').format(
                dir=dir,
                dest_name=dest_name
            ),
        ]

def shell_builder.ShellFBCodeBuilder.copy_local_repo	(		self,
			dir,
			dest_name
	)

Definition at line 69 of file shell_builder.py.

References utils.build_fbcode_builder_config(), shell_builder.ShellFBCodeBuilder.copy_local_repo(), shell_builder.find_project_root(), folly.format(), shell_builder.make_steps, shell_builder.persistent_temp_dir(), utils.read_fbcode_builder_config(), and replace().

    def copy_local_repo(self, dir, dest_name):
        return [
            ShellQuoted('cp -r {dir} {dest_name}').format(
                dir=dir,
                dest_name=dest_name
            ),
        ]

def shell_builder.ShellFBCodeBuilder.copy_local_repo	(		self,
			dir,
			dest_name
	)

Definition at line 69 of file shell_builder.py.

References utils.build_fbcode_builder_config(), shell_builder.ShellFBCodeBuilder.copy_local_repo(), shell_builder.find_project_root(), folly.format(), shell_builder.make_steps, shell_builder.persistent_temp_dir(), utils.read_fbcode_builder_config(), and replace().

    def copy_local_repo(self, dir, dest_name):
        return [
            ShellQuoted('cp -r {dir} {dest_name}').format(
                dir=dir,
                dest_name=dest_name
            ),
        ]

def shell_builder.ShellFBCodeBuilder.copy_local_repo	(		self,
			dir,
			dest_name
	)

Definition at line 69 of file shell_builder.py.

References folly.format().

Referenced by shell_builder.ShellFBCodeBuilder.copy_local_repo().

    def copy_local_repo(self, dir, dest_name):
        return [
            ShellQuoted('cp -r {dir} {dest_name}').format(
                dir=dir,
                dest_name=dest_name
            ),
        ]

def shell_builder.ShellFBCodeBuilder.run	(		self,
			shell_cmd
	)

Definition at line 43 of file shell_builder.py.

References folly.format(), and shell_builder.ShellFBCodeBuilder.run().

    def run(self, shell_cmd):
        return ShellQuoted('{cmd}').format(cmd=shell_cmd)

def shell_builder.ShellFBCodeBuilder.run	(		self,
			shell_cmd
	)

Definition at line 43 of file shell_builder.py.

References folly.format(), and shell_builder.ShellFBCodeBuilder.run().

    def run(self, shell_cmd):
        return ShellQuoted('{cmd}').format(cmd=shell_cmd)

def shell_builder.ShellFBCodeBuilder.run	(		self,
			shell_cmd
	)

Definition at line 43 of file shell_builder.py.

References folly.format().

Referenced by shell_builder.ShellFBCodeBuilder.run().

    def run(self, shell_cmd):
        return ShellQuoted('{cmd}').format(cmd=shell_cmd)

def shell_builder.ShellFBCodeBuilder.run	(		self,
			shell_cmd
	)

Definition at line 43 of file shell_builder.py.

References folly.format(), and shell_builder.ShellFBCodeBuilder.run().

    def run(self, shell_cmd):
        return ShellQuoted('{cmd}').format(cmd=shell_cmd)

def shell_builder.ShellFBCodeBuilder.setup

(

self

)

Definition at line 51 of file shell_builder.py.

References folly.format(), fbcode_builder.FBCodeBuilder.has_option(), and fbcode_builder.FBCodeBuilder.option().

Referenced by shell_builder.ShellFBCodeBuilder.setup().

    def setup(self):
        steps = [
            ShellQuoted('set -exo pipefail'),
        ]
        if self.has_option('ccache_dir'):
            ccache_dir = self.option('ccache_dir')
            steps += [
                ShellQuoted(
                    # Set CCACHE_DIR before the `ccache` invocations below.
                    'export CCACHE_DIR={ccache_dir} '
                    'CC="ccache ${{CC:-gcc}}" CXX="ccache ${{CXX:-g++}}"'
                ).format(ccache_dir=ccache_dir)
            ]
        return steps

def shell_builder.ShellFBCodeBuilder.setup

(

self

)

Definition at line 51 of file shell_builder.py.

References folly.format(), fbcode_builder.FBCodeBuilder.has_option(), fbcode_builder.FBCodeBuilder.option(), and shell_builder.ShellFBCodeBuilder.setup().

    def setup(self):
        steps = [
            ShellQuoted('set -exo pipefail'),
        ]
        if self.has_option('ccache_dir'):
            ccache_dir = self.option('ccache_dir')
            steps += [
                ShellQuoted(
                    # Set CCACHE_DIR before the `ccache` invocations below.
                    'export CCACHE_DIR={ccache_dir} '
                    'CC="ccache ${{CC:-gcc}}" CXX="ccache ${{CXX:-g++}}"'
                ).format(ccache_dir=ccache_dir)
            ]
        return steps

def shell_builder.ShellFBCodeBuilder.setup

(

self

)

Definition at line 51 of file shell_builder.py.

References folly.format(), fbcode_builder.FBCodeBuilder.has_option(), fbcode_builder.FBCodeBuilder.option(), and shell_builder.ShellFBCodeBuilder.setup().

    def setup(self):
        steps = [
            ShellQuoted('set -exo pipefail'),
        ]
        if self.has_option('ccache_dir'):
            ccache_dir = self.option('ccache_dir')
            steps += [
                ShellQuoted(
                    # Set CCACHE_DIR before the `ccache` invocations below.
                    'export CCACHE_DIR={ccache_dir} '
                    'CC="ccache ${{CC:-gcc}}" CXX="ccache ${{CXX:-g++}}"'
                ).format(ccache_dir=ccache_dir)
            ]
        return steps

def shell_builder.ShellFBCodeBuilder.setup

(

self

)

Definition at line 51 of file shell_builder.py.

References folly.format(), fbcode_builder.FBCodeBuilder.has_option(), fbcode_builder.FBCodeBuilder.option(), and shell_builder.ShellFBCodeBuilder.setup().

    def setup(self):
        steps = [
            ShellQuoted('set -exo pipefail'),
        ]
        if self.has_option('ccache_dir'):
            ccache_dir = self.option('ccache_dir')
            steps += [
                ShellQuoted(
                    # Set CCACHE_DIR before the `ccache` invocations below.
                    'export CCACHE_DIR={ccache_dir} '
                    'CC="ccache ${{CC:-gcc}}" CXX="ccache ${{CXX:-g++}}"'
                ).format(ccache_dir=ccache_dir)
            ]
        return steps

def shell_builder.ShellFBCodeBuilder.step	(		self,
			name,
			actions
	)

Definition at line 46 of file shell_builder.py.

References folly.format().

Referenced by shell_builder.ShellFBCodeBuilder.step().

    def step(self, name, actions):
        assert '\n' not in name, 'Name {0} would span > 1 line'.format(name)
        b = ShellQuoted('')
        return [ShellQuoted('### {0} ###'.format(name)), b] + actions + [b]

def shell_builder.ShellFBCodeBuilder.step	(		self,
			name,
			actions
	)

Definition at line 46 of file shell_builder.py.

References folly.format(), and shell_builder.ShellFBCodeBuilder.step().

    def step(self, name, actions):
        assert '\n' not in name, 'Name {0} would span > 1 line'.format(name)
        b = ShellQuoted('')
        return [ShellQuoted('### {0} ###'.format(name)), b] + actions + [b]

def shell_builder.ShellFBCodeBuilder.step	(		self,
			name,
			actions
	)

Definition at line 46 of file shell_builder.py.

References folly.format(), and shell_builder.ShellFBCodeBuilder.step().

    def step(self, name, actions):
        assert '\n' not in name, 'Name {0} would span > 1 line'.format(name)
        b = ShellQuoted('')
        return [ShellQuoted('### {0} ###'.format(name)), b] + actions + [b]

def shell_builder.ShellFBCodeBuilder.step	(		self,
			name,
			actions
	)

Definition at line 46 of file shell_builder.py.

References folly.format(), and shell_builder.ShellFBCodeBuilder.step().

    def step(self, name, actions):
        assert '\n' not in name, 'Name {0} would span > 1 line'.format(name)
        b = ShellQuoted('')
        return [ShellQuoted('### {0} ###'.format(name)), b] + actions + [b]

def shell_builder.ShellFBCodeBuilder.workdir	(		self,
			dir
	)

Definition at line 36 of file shell_builder.py.

References folly.format(), and shell_builder.ShellFBCodeBuilder.workdir().

    def workdir(self, dir):
        return [
            ShellQuoted('mkdir -p {d} && cd {d}').format(
                d=dir
            ),
        ]

def shell_builder.ShellFBCodeBuilder.workdir	(		self,
			dir
	)

Definition at line 36 of file shell_builder.py.

References folly.format(), and shell_builder.ShellFBCodeBuilder.workdir().

    def workdir(self, dir):
        return [
            ShellQuoted('mkdir -p {d} && cd {d}').format(
                d=dir
            ),
        ]

def shell_builder.ShellFBCodeBuilder.workdir	(		self,
			dir
	)

Definition at line 36 of file shell_builder.py.

References folly.format(), and shell_builder.ShellFBCodeBuilder.workdir().

    def workdir(self, dir):
        return [
            ShellQuoted('mkdir -p {d} && cd {d}').format(
                d=dir
            ),
        ]

def shell_builder.ShellFBCodeBuilder.workdir	(		self,
			dir
	)

Definition at line 36 of file shell_builder.py.

References folly.format().

Referenced by shell_builder.ShellFBCodeBuilder.workdir().

    def workdir(self, dir):
        return [
            ShellQuoted('mkdir -p {d} && cd {d}').format(
                d=dir
            ),
        ]

---

The documentation for this class was generated from the following file:

• build/fbcode_builder/shell_builder.py