pyccel.plugins.hookspecs module

Hook specifications for the pyccel plugin system.

All functions in this module are decorated with @hookspec and define the interface that pyccel plugins may implement. Plugin authors should decorate their implementations with pyccel.plugins.hookimpl.

pyccel.plugins.hookspecs.add_cli_options(parser: ArgumentParser, cli_tool: str)View on GitHub

Add extra options to the command line tools.

Add extra options, specific to the plugin, to the command line tools. Options should be added to the argument parser, preferably in a new group.

Parameters:

• parser (ArgumentParser) – The argument parser to which any options should be added.

• cli_tool (str) – The name of the tool being used.

pyccel.plugins.hookspecs.get_build_generation_class(build_gen_method: str)View on GitHub

Return the build-generation class for the requested build method.

Return a build-generation class which handles building with the specified framework. This method can be used to add support for a new build framework. It will only be called for build methods which are not already implemented by Pyccel. To extend an existing Codegen class, use get_updated_build_generation_methods.

This hook is optional. It should only be implemented if the plugin needs it.

Parameters:

build_gen_method (str) – The name of the build generation method (e.g. ‘cmake’).

Returns:

The build-generation class for the requested method or None if this plugin doesn’t implement the requested method. This should be a sub-class of pyccel.codegen.build_generation.build_gen.BuildSystemHandler.

Return type:

type

pyccel.plugins.hookspecs.get_codegen_class(language: str)View on GitHub

Return the code-generation class to use for language.

Return a code-generation class which handles translation to the specified language. This method can be used to add support for a new language. It will only be called for languages which are not already implemented by Pyccel. To extend an existing Codegen class, use get_updated_codegen_methods.

This hook is optional. It should only be implemented if the plugin needs it.

Parameters:

language (str) – The target language (e.g. ‘cuda’).

Returns:

The code-generation class for the requested language or None if this plugin doesn’t implement the requested language. This should be a sub-class of pyccel.codegen.printing.codeprinter.CodePrinter.

Return type:

type

pyccel.plugins.hookspecs.get_description() → strView on GitHub

Return a one-line description of the LineAnnot plugin for the CLI help text.

Return a one-line description of the LineAnnot plugin for the CLI help text.

Returns:

Human-readable description of what the plugin does.

Return type:

str

pyccel.plugins.hookspecs.get_extra_accelerators() → Iterable[str]View on GitHub

Return the names of any additional accelerators required by the plugin.

Return the names of any additional accelerators required by the plugin. These accelerators affect the compilation of the code and should appear in the compiler configurations.

This hook is optional. It should only be implemented if the plugin needs it.

Returns:

Names of the accelerators made available by the plugin (e.g. ['openmp']).

Return type:

Iterable[str]

pyccel.plugins.hookspecs.get_updated_build_generation_methods(build_gen_method: str) → Iterable[LambdaType]View on GitHub

Return methods to be added or overridden in the build-generation class.

Return methods to be added to or to override methods in the build-generation class. The returned callables are injected into a dynamically created subclass of the base build generation class, so each callable must accept self as its first argument. If the name of the method matches one from the BuildSystemHandler subclass, the original method is overwritten. Otherwise, the method is simply added to the new subclass. Please bear in mind that methods appearing in BuildSystemHandler classes may have been modified by other plugins, and extra methods may have already been added to a subclass by other plugins.

This hook is optional. It should only be implemented if the plugin needs it.

Parameters:

build_gen_method (str) – The name of the build generation method (e.g. ‘cmake’).

Returns:

Functions to be added or to override build-generation methods.

Return type:

Iterable[FunctionType]

pyccel.plugins.hookspecs.get_updated_codegen_methods(language: str) → Iterable[LambdaType]View on GitHub

Return methods to be added to or to override methods in the code-generation class.

Return methods to be added to or to override methods in the code-generation class for language. The returned callables are injected into a dynamically created subclass of the base code-generation class, so each callable must accept self as its first argument. If the name of the method matches one from the Codegen subclass, the original method is overwritten. Otherwise, the method is simply added to the new subclass. Please bear in mind that methods appearing in Codegen classes may have been modified by other plugins, and extra methods may have already been added to a subclass by other plugins.

This hook is optional. It should only be implemented if the plugin needs it.

Parameters:

language (str) – The target language (e.g. ‘c’, ‘fortran’).

Returns:

Functions to be added or to override codegen methods.

Return type:

Iterable[FunctionType]

pyccel.plugins.hookspecs.get_updated_semantic_methods() → Iterable[LambdaType]View on GitHub

Return methods to be added to or to override methods in the semantic parser class.

The returned callables are injected into a dynamically created subclass of the base semantic parser, so each callable must accept self as its first argument. If the name of the method matches one from SemanticParser (or a subclass), the original method is overwritten. Otherwise, the method is simply added to the new subclass. Please bear in mind that methods appearing in SemanticParser may have been modified by other plugins, and extra methods may have already been added to a subclass by other plugins.

This hook is optional. It should only be implemented if the plugin needs it.

Returns:

Functions to be added or to override semantic methods.

Return type:

Iterable[FunctionType]

pyccel.plugins.hookspecs.get_updated_syntactic_methods() → Iterable[LambdaType]View on GitHub

Return methods to be added to or to override methods in the syntactic parser class.

The returned callables are injected into a dynamically created subclass of the base syntactic parser, so each callable must accept self as its first argument. If the name of the method matches one from SyntaxParser (or a subclass), the original method is overwritten. Otherwise, the method is simply added to the new subclass. Please bear in mind that methods appearing in SyntaxParser may have been modified by other plugins, and extra methods may have already been added to a subclass by other plugins.

This hook is optional. It should only be implemented if the plugin needs it.

Returns:

Functions to be added or to override syntactic methods.

Return type:

Iterable[FunctionType]

pyccel.plugins.hookspecs.get_updated_wrapper_codegen_methods(language: str) → Iterable[LambdaType]View on GitHub

Return methods to be added to or to override methods in the code-generation class for wrapping.

Return methods to be added to or to override methods in the code-generation class for language. The returned callables are injected into a dynamically created subclass of the base code-generation class, so each callable must accept self as its first argument. If the name of the method matches one from the Codegen subclass, the original method is overwritten. Otherwise, the method is simply added to the new subclass. Please bear in mind that methods appearing in Codegen classes may have been modified by other plugins, and extra methods may have already been added to a subclass by other plugins.

This hook is optional. It should only be implemented if the plugin needs it.

Parameters:

language (str) – The target language (e.g. ‘c’, ‘fortran’).

Returns:

Functions to be added or to override codegen methods.

Return type:

Iterable[FunctionType]

pyccel.plugins.hookspecs.get_updated_wrapper_methods(start_language: str, target_language: str) → Iterable[LambdaType]View on GitHub

Return methods to be added or overridden in the wrapper class for a language pair.

Return methods to be added to or to override methods in a wrapper class which converts code from start_language to target_language. The returned callables are injected into a dynamically created subclass of the base wrapper class, so each callable must accept self as its first argument. If the name of the method matches one from the Wrapper subclass, the original method is overwritten. Otherwise, the method is simply added to the new subclass. Please bear in mind that methods appearing in Wrapper classes may have been modified by other plugins, and extra methods may have already been added to a subclass by other plugins.

This hook is optional. It should only be implemented if the plugin needs it.

Parameters:

• start_language (str) – The source language of the wrapper (e.g. ‘fortran’).

• target_language (str) – The target language of the wrapper (e.g. ‘python’).

Returns:

Functions to be added or to override wrapper methods.

Return type:

Iterable[FunctionType]

pyccel.plugins.hookspecs.get_wrapper_class(start_language: str) → tuple[type, str] | NoneView on GitHub

Return the wrapper class for converting code from start_language to target_language.

Return a wrapper class which converts code from start_language to target_language. This method can be used to add support for a new language. It will only be called for languages which are not already implemented by Pyccel. To extend an existing Codegen class, use get_updated_wrapper_methods.

This hook is optional. It should only be implemented if the plugin needs it.

Parameters:

start_language (str) – The source language of the wrapper (e.g. ‘fortran’).

Returns:

• wrapper_class (type) – The wrapper class for the requested language set or None if this plugin doesn’t implement the requested language translation. This should be a sub-class of pyccel.codegen.wrapper.wrapper.Wrapper.

• target_language (str) – The target language of the wrapper (e.g. ‘python’).

pyccel.plugins.hookspecs.get_wrapper_codegen_class(language: str)View on GitHub

Return the code-generation class to use for printing the wrapper in language.

Return a code-generation class which handles translation to the specified language. This method can be used to add support for a new language. It will only be called for languages which are not already implemented by Pyccel. To extend an existing Codegen class, use get_updated_wrapper_codegen_methods.

This hook is optional. It should only be implemented if the plugin needs it.

Parameters:

language (str) – The target language (e.g. ‘cuda’).

Returns:

The code-generation class for the requested language or None if this plugin doesn’t implement the requested language. This should be a sub-class of pyccel.codegen.printing.codeprinter.CodePrinter.

Return type:

type

pyccel.plugins.hookspecs.read_cli_arguments(kwargs: dict)View on GitHub

Read any arguments from the kwargs dictionary.

Read any arguments added via add_cli_options from the kwargs dictionary. Any arguments relevant to the plugin should be removed from the kwargs so the rest of the code cannot be influenced by the plugin. Beware kwargs can also come from epyccel so default values may be missing.

Parameters:

kwargs (dict) – The keyword arguments passed to the pipeline.