zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

use double quotes where spack style finds errors (#41349)

Browse Source
This commit is contained in:
Christopher Christofi 2023-11-30 08:46:02 +00:00 committed by GitHub
parent 3b045c289d
commit 3bc8a7aa5f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 80 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
lib/spack/docs/build_systems/cmakepackage.rst
View File

@ -82,7 +82,7 @@ class already contains:
.. code-block:: python .. code-block:: python
depends_on('cmake', type='build') depends_on("cmake", type="build")
If you need to specify a particular version requirement, you can If you need to specify a particular version requirement, you can
@ -90,7 +90,7 @@ override this in your package:
.. code-block:: python .. code-block:: python
depends_on('cmake@2.8.12:', type='build') depends_on("cmake@2.8.12:", type="build")
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
@ -137,10 +137,10 @@ and without the :meth:`~spack.build_systems.cmake.CMakeBuilder.define` and
def cmake_args(self): def cmake_args(self):
args = [ args = [
'-DWHATEVER:STRING=somevalue', "-DWHATEVER:STRING=somevalue",
self.define('ENABLE_BROKEN_FEATURE', False), self.define("ENABLE_BROKEN_FEATURE", False),
self.define_from_variant('DETECT_HDF5', 'hdf5'), self.define_from_variant("DETECT_HDF5", "hdf5"),
self.define_from_variant('THREADS'), # True if +threads self.define_from_variant("THREADS"), # True if +threads
] ]
return args return args
@ -151,10 +151,10 @@ and CMake simply ignores the empty command line argument. For example the follow
.. code-block:: python .. code-block:: python
variant('example', default=True, when='@2.0:') variant("example", default=True, when="@2.0:")
def cmake_args(self): def cmake_args(self):
return [self.define_from_variant('EXAMPLE', 'example')] return [self.define_from_variant("EXAMPLE", "example")]
will generate ``'cmake' '-DEXAMPLE=ON' ...`` when `@2.0: +example` is met, but will will generate ``'cmake' '-DEXAMPLE=ON' ...`` when `@2.0: +example` is met, but will
result in ``'cmake' '' ...`` when the spec version is below ``2.0``. result in ``'cmake' '' ...`` when the spec version is below ``2.0``.
@ -193,9 +193,9 @@ a variant to control this:
.. code-block:: python .. code-block:: python
variant('build_type', default='RelWithDebInfo', variant("build_type", default="RelWithDebInfo",
description='CMake build type', description="CMake build type",
values=('Debug', 'Release', 'RelWithDebInfo', 'MinSizeRel')) values=("Debug", "Release", "RelWithDebInfo", "MinSizeRel"))
However, not every CMake package accepts all four of these options. However, not every CMake package accepts all four of these options.
Grep the ``CMakeLists.txt`` file to see if the default values are Grep the ``CMakeLists.txt`` file to see if the default values are
@ -205,9 +205,9 @@ package overrides the default variant with:
.. code-block:: python .. code-block:: python
variant('build_type', default='DebugRelease', variant("build_type", default="DebugRelease",
description='The build type to build', description="The build type to build",
values=('Debug', 'Release', 'DebugRelease')) values=("Debug", "Release", "DebugRelease"))
For more information on ``CMAKE_BUILD_TYPE``, see: For more information on ``CMAKE_BUILD_TYPE``, see:
https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html
@ -250,7 +250,7 @@ generator is Ninja. To switch to the Ninja generator, simply add:
.. code-block:: python .. code-block:: python
generator = 'Ninja' generator = "Ninja"
``CMakePackage`` defaults to "Unix Makefiles". If you switch to the ``CMakePackage`` defaults to "Unix Makefiles". If you switch to the
@ -258,7 +258,7 @@ Ninja generator, make sure to add:
.. code-block:: python .. code-block:: python
depends_on('ninja', type='build') depends_on("ninja", type="build")
to the package as well. Aside from that, you shouldn't need to do to the package as well. Aside from that, you shouldn't need to do
anything else. Spack will automatically detect that you are using anything else. Spack will automatically detect that you are using
@ -288,7 +288,7 @@ like so:
.. code-block:: python .. code-block:: python
root_cmakelists_dir = 'src' root_cmakelists_dir = "src"
Note that this path is relative to the root of the extracted tarball, Note that this path is relative to the root of the extracted tarball,
@ -304,7 +304,7 @@ different sub-directory, simply override ``build_directory`` like so:
.. code-block:: python .. code-block:: python
build_directory = 'my-build' build_directory = "my-build"
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
Build and install targets Build and install targets
@ -324,8 +324,8 @@ library or build the documentation, you can add these like so:
.. code-block:: python .. code-block:: python
build_targets = ['all', 'docs'] build_targets = ["all", "docs"]
install_targets = ['install', 'docs'] install_targets = ["install", "docs"]
^^^^^^^ ^^^^^^^
Testing Testing

14
lib/spack/docs/build_systems/intelpackage.rst
View File

@ -934,9 +934,9 @@ a *virtual* ``mkl`` package is declared in Spack.
.. code-block:: python .. code-block:: python
# Examples for absolute and conditional dependencies: # Examples for absolute and conditional dependencies:
depends_on('mkl') depends_on("mkl")
depends_on('mkl', when='+mkl') depends_on("mkl", when="+mkl")
depends_on('mkl', when='fftw=mkl') depends_on("mkl", when="fftw=mkl")
The ``MKLROOT`` environment variable (part of the documented API) will be set The ``MKLROOT`` environment variable (part of the documented API) will be set
during all stages of client package installation, and is available to both during all stages of client package installation, and is available to both
@ -972,8 +972,8 @@ a *virtual* ``mkl`` package is declared in Spack.
def configure_args(self): def configure_args(self):
args = [] args = []
... ...
args.append('--with-blas=%s' % self.spec['blas'].libs.ld_flags) args.append("--with-blas=%s" % self.spec["blas"].libs.ld_flags)
args.append('--with-lapack=%s' % self.spec['lapack'].libs.ld_flags) args.append("--with-lapack=%s" % self.spec["lapack"].libs.ld_flags)
... ...
.. tip:: .. tip::
@ -989,13 +989,13 @@ a *virtual* ``mkl`` package is declared in Spack.
.. code-block:: python .. code-block:: python
self.spec['blas'].headers.include_flags self.spec["blas"].headers.include_flags
and to generate linker options (``-L<dir> -llibname ...``), use the same as above, and to generate linker options (``-L<dir> -llibname ...``), use the same as above,
.. code-block:: python .. code-block:: python
self.spec['blas'].libs.ld_flags self.spec["blas"].libs.ld_flags
See See
:ref:`MakefilePackage <makefilepackage>` :ref:`MakefilePackage <makefilepackage>`

2
lib/spack/docs/build_systems/luapackage.rst
View File

@ -88,7 +88,7 @@ override the ``luarocks_args`` method like so:
.. code-block:: python .. code-block:: python
def luarocks_args(self): def luarocks_args(self):
return ['flag1', 'flag2'] return ["flag1", "flag2"]
One common use of this is to override warnings or flags for newer compilers, as in: One common use of this is to override warnings or flags for newer compilers, as in:

14
lib/spack/docs/build_systems/mavenpackage.rst
View File

@ -48,8 +48,8 @@ class automatically adds the following dependencies:
.. code-block:: python .. code-block:: python
depends_on('java', type=('build', 'run')) depends_on("java", type=("build", "run"))
depends_on('maven', type='build') depends_on("maven", type="build")
In the ``pom.xml`` file, you may see sections like: In the ``pom.xml`` file, you may see sections like:
@ -72,8 +72,8 @@ should add:
.. code-block:: python .. code-block:: python
depends_on('java@7:', type='build') depends_on("java@7:", type="build")
depends_on('maven@3.5.4:', type='build') depends_on("maven@3.5.4:", type="build")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -88,9 +88,9 @@ the build phase. For example:
def build_args(self): def build_args(self):
return [ return [
'-Pdist,native', "-Pdist,native",
'-Dtar', "-Dtar",
'-Dmaven.javadoc.skip=true' "-Dmaven.javadoc.skip=true"
] ]

10
lib/spack/docs/build_systems/mesonpackage.rst
View File

@ -86,8 +86,8 @@ the ``MesonPackage`` base class already contains:
.. code-block:: python .. code-block:: python
depends_on('meson', type='build') depends_on("meson", type="build")
depends_on('ninja', type='build') depends_on("ninja", type="build")
If you need to specify a particular version requirement, you can If you need to specify a particular version requirement, you can
@ -95,8 +95,8 @@ override this in your package:
.. code-block:: python .. code-block:: python
depends_on('meson@0.43.0:', type='build') depends_on("meson@0.43.0:", type="build")
depends_on('ninja', type='build') depends_on("ninja", type="build")
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
@ -121,7 +121,7 @@ override the ``meson_args`` method like so:
.. code-block:: python .. code-block:: python
def meson_args(self): def meson_args(self):
return ['--warnlevel=3'] return ["--warnlevel=3"]
This method can be used to pass flags as well as variables. This method can be used to pass flags as well as variables.

12
lib/spack/docs/build_systems/perlpackage.rst
View File

@ -118,7 +118,7 @@ so ``PerlPackage`` contains:
.. code-block:: python .. code-block:: python
extends('perl') extends("perl")
If your package requires a specific version of Perl, you should If your package requires a specific version of Perl, you should
@ -132,14 +132,14 @@ properly. If your package uses ``Makefile.PL`` to build, add:
.. code-block:: python .. code-block:: python
depends_on('perl-extutils-makemaker', type='build') depends_on("perl-extutils-makemaker", type="build")
If your package uses ``Build.PL`` to build, add: If your package uses ``Build.PL`` to build, add:
.. code-block:: python .. code-block:: python
depends_on('perl-module-build', type='build') depends_on("perl-module-build", type="build")
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
@ -165,11 +165,11 @@ arguments to ``Makefile.PL`` or ``Build.PL`` by overriding
.. code-block:: python .. code-block:: python
def configure_args(self): def configure_args(self):
expat = self.spec['expat'].prefix expat = self.spec["expat"].prefix
return [ return [
'EXPATLIBPATH={0}'.format(expat.lib), "EXPATLIBPATH={0}".format(expat.lib),
'EXPATINCPATH={0}'.format(expat.include), "EXPATINCPATH={0}".format(expat.include),
] ]

8
lib/spack/docs/build_systems/qmakepackage.rst
View File

@ -83,7 +83,7 @@ base class already contains:
.. code-block:: python .. code-block:: python
depends_on('qt', type='build') depends_on("qt", type="build")
If you want to specify a particular version requirement, or need to If you want to specify a particular version requirement, or need to
@ -91,7 +91,7 @@ link to the ``qt`` libraries, you can override this in your package:
.. code-block:: python .. code-block:: python
depends_on('qt@5.6.0:') depends_on("qt@5.6.0:")
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^
Passing arguments to qmake Passing arguments to qmake
@ -103,7 +103,7 @@ override the ``qmake_args`` method like so:
.. code-block:: python .. code-block:: python
def qmake_args(self): def qmake_args(self):
return ['-recursive'] return ["-recursive"]
This method can be used to pass flags as well as variables. This method can be used to pass flags as well as variables.
@ -118,7 +118,7 @@ sub-directory by adding the following to the package:
.. code-block:: python .. code-block:: python
build_directory = 'src' build_directory = "src"
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^

38
lib/spack/docs/build_systems/rpackage.rst
View File

@ -163,28 +163,28 @@ attributes that can be used to set ``homepage``, ``url``, ``list_url``, and
.. code-block:: python .. code-block:: python
cran = 'caret' cran = "caret"
is equivalent to: is equivalent to:
.. code-block:: python .. code-block:: python
homepage = 'https://cloud.r-project.org/package=caret' homepage = "https://cloud.r-project.org/package=caret"
url = 'https://cloud.r-project.org/src/contrib/caret_6.0-86.tar.gz' url = "https://cloud.r-project.org/src/contrib/caret_6.0-86.tar.gz"
list_url = 'https://cloud.r-project.org/src/contrib/Archive/caret' list_url = "https://cloud.r-project.org/src/contrib/Archive/caret"
Likewise, the following ``bioc`` attribute: Likewise, the following ``bioc`` attribute:
.. code-block:: python .. code-block:: python
bioc = 'BiocVersion' bioc = "BiocVersion"
is equivalent to: is equivalent to:
.. code-block:: python .. code-block:: python
homepage = 'https://bioconductor.org/packages/BiocVersion/' homepage = "https://bioconductor.org/packages/BiocVersion/"
git = 'https://git.bioconductor.org/packages/BiocVersion' git = "https://git.bioconductor.org/packages/BiocVersion"
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
@ -200,7 +200,7 @@ base class contains:
.. code-block:: python .. code-block:: python
extends('r') extends("r")
Take a close look at the homepage for ``caret``. If you look at the Take a close look at the homepage for ``caret``. If you look at the
@ -209,7 +209,7 @@ You should add this to your package like so:
.. code-block:: python .. code-block:: python
depends_on('r@3.2.0:', type=('build', 'run')) depends_on("r@3.2.0:", type=("build", "run"))
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
@ -227,7 +227,7 @@ and list all of their dependencies in the following sections:
* LinkingTo * LinkingTo
As far as Spack is concerned, all 3 of these dependency types As far as Spack is concerned, all 3 of these dependency types
correspond to ``type=('build', 'run')``, so you don't have to worry correspond to ``type=("build", "run")``, so you don't have to worry
about the details. If you are curious what they mean, about the details. If you are curious what they mean,
https://github.com/spack/spack/issues/2951 has a pretty good summary: https://github.com/spack/spack/issues/2951 has a pretty good summary:
@ -330,7 +330,7 @@ the dependency:
.. code-block:: python .. code-block:: python
depends_on('r-lattice@0.20:', type=('build', 'run')) depends_on("r-lattice@0.20:", type=("build", "run"))
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
@ -361,20 +361,20 @@ like so:
.. code-block:: python .. code-block:: python
def configure_args(self): def configure_args(self):
mpi_name = self.spec['mpi'].name mpi_name = self.spec["mpi"].name
# The type of MPI. Supported values are: # The type of MPI. Supported values are:
# OPENMPI, LAM, MPICH, MPICH2, or CRAY # OPENMPI, LAM, MPICH, MPICH2, or CRAY
if mpi_name == 'openmpi': if mpi_name == "openmpi":
Rmpi_type = 'OPENMPI' Rmpi_type = "OPENMPI"
elif mpi_name == 'mpich': elif mpi_name == "mpich":
Rmpi_type = 'MPICH2' Rmpi_type = "MPICH2"
else: else:
raise InstallError('Unsupported MPI type') raise InstallError("Unsupported MPI type")
return [ return [
'--with-Rmpi-type={0}'.format(Rmpi_type), "--with-Rmpi-type={0}".format(Rmpi_type),
'--with-mpi={0}'.format(spec['mpi'].prefix), "--with-mpi={0}".format(spec["mpi"].prefix),
] ]

12
lib/spack/docs/build_systems/rubypackage.rst
View File

@ -84,8 +84,8 @@ The ``*.gemspec`` file may contain something like:
.. code-block:: ruby .. code-block:: ruby
summary = 'An implementation of the AsciiDoc text processor and publishing toolchain' summary = "An implementation of the AsciiDoc text processor and publishing toolchain"
description = 'A fast, open source text processor and publishing toolchain for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.' description = "A fast, open source text processor and publishing toolchain for converting AsciiDoc content to HTML 5, DocBook 5, and other formats."
Either of these can be used for the description of the Spack package. Either of these can be used for the description of the Spack package.
@ -98,7 +98,7 @@ The ``*.gemspec`` file may contain something like:
.. code-block:: ruby .. code-block:: ruby
homepage = 'https://asciidoctor.org' homepage = "https://asciidoctor.org"
This should be used as the official homepage of the Spack package. This should be used as the official homepage of the Spack package.
@ -112,21 +112,21 @@ the base class contains:
.. code-block:: python .. code-block:: python
extends('ruby') extends("ruby")
The ``*.gemspec`` file may contain something like: The ``*.gemspec`` file may contain something like:
.. code-block:: ruby .. code-block:: ruby
required_ruby_version = '>= 2.3.0' required_ruby_version = ">= 2.3.0"
This can be added to the Spack package using: This can be added to the Spack package using:
.. code-block:: python .. code-block:: python
depends_on('ruby@2.3.0:', type=('build', 'run')) depends_on("ruby@2.3.0:", type=("build", "run"))
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^

2
lib/spack/docs/build_systems/sippackage.rst
View File

@ -124,7 +124,7 @@ are wrong, you can provide the names yourself by overriding
.. code-block:: python .. code-block:: python
import_modules = ['PyQt5'] import_modules = ["PyQt5"]
These tests often catch missing dependencies and non-RPATHed These tests often catch missing dependencies and non-RPATHed

8
lib/spack/docs/build_systems/wafpackage.rst
View File

@ -63,8 +63,8 @@ run package-specific unit tests.
.. code-block:: python .. code-block:: python
def installtest(self): def installtest(self):
with working_dir('test'): with working_dir("test"):
pytest = which('py.test') pytest = which("py.test")
pytest() pytest()
@ -93,7 +93,7 @@ the following dependency automatically:
.. code-block:: python .. code-block:: python
depends_on('python@2.5:', type='build') depends_on("python@2.5:", type="build")
Waf only supports Python 2.5 and up. Waf only supports Python 2.5 and up.
@ -113,7 +113,7 @@ phase, you can use:
args = [] args = []
if self.run_tests: if self.run_tests:
args.append('--test') args.append("--test")
return args return args