From 4e269510c565ad7be52bd9c290af19c7115e67af Mon Sep 17 00:00:00 2001 From: "Adam J. Stewart" Date: Thu, 3 Aug 2017 14:24:51 -0500 Subject: Fix trailing whitespace at the end of headers.cpp_flags (#4957) --- lib/spack/llnl/util/filesystem.py | 93 ++++++++++++++++++++++++++++++++------- 1 file changed, 77 insertions(+), 16 deletions(-) diff --git a/lib/spack/llnl/util/filesystem.py b/lib/spack/llnl/util/filesystem.py index 7a9fb7b8ac..bedc7c9de2 100644 --- a/lib/spack/llnl/util/filesystem.py +++ b/lib/spack/llnl/util/filesystem.py @@ -549,7 +549,7 @@ def find(root, files, recurse=True): if True descends top-down from the root. Defaults to True. Returns: - :func:`list`: The files that have been found + list of strings: The files that have been found """ if isinstance(files, six.string_types): files = [files] @@ -618,9 +618,14 @@ class FileList(collections.Sequence): """Stable de-duplication of the directories where the files reside. >>> l = LibraryList(['/dir1/liba.a', '/dir2/libb.a', '/dir1/libc.a']) - >>> assert l.directories == ['/dir1', '/dir2'] + >>> l.directories + ['/dir1', '/dir2'] >>> h = HeaderList(['/dir1/a.h', '/dir1/b.h', '/dir2/c.h']) - >>> assert h.directories == ['/dir1', '/dir2'] + >>> h.directories + ['/dir1', '/dir2'] + + Returns: + list of strings: A list of directories """ return list(dedupe( os.path.dirname(x) for x in self.files if os.path.dirname(x) @@ -631,18 +636,27 @@ class FileList(collections.Sequence): """Stable de-duplication of the base-names in the list >>> l = LibraryList(['/dir1/liba.a', '/dir2/libb.a', '/dir3/liba.a']) - >>> assert l.basenames == ['liba.a', 'libb.a'] + >>> l.basenames + ['liba.a', 'libb.a'] >>> h = HeaderList(['/dir1/a.h', '/dir2/b.h', '/dir3/a.h']) - >>> assert h.basenames == ['a.h', 'b.h'] + >>> h.basenames + ['a.h', 'b.h'] + + Returns: + list of strings: A list of base-names """ return list(dedupe(os.path.basename(x) for x in self.files)) @property def names(self): - """Stable de-duplication of file names in the list + """Stable de-duplication of file names in the list without extensions >>> h = HeaderList(['/dir1/a.h', '/dir2/b.h', '/dir3/a.h']) - >>> assert h.names == ['a', 'b'] + >>> h.names + ['a', 'b'] + + Returns: + list of strings: A list of files without extensions """ return list(dedupe(x.split('.')[0] for x in self.basenames)) @@ -688,6 +702,11 @@ class HeaderList(FileList): @property def headers(self): + """Stable de-duplication of the headers. + + Returns: + list of strings: A list of header files + """ return self.files @property @@ -695,7 +714,11 @@ class HeaderList(FileList): """Include flags >>> h = HeaderList(['/dir1/a.h', '/dir1/b.h', '/dir2/c.h']) - >>> assert h.cpp_flags == '-I/dir1 -I/dir2' + >>> h.include_flags + '-I/dir1 -I/dir2' + + Returns: + str: A joined list of include flags """ return ' '.join(['-I' + x for x in self.directories]) @@ -706,7 +729,11 @@ class HeaderList(FileList): >>> h = HeaderList(['/dir1/a.h', '/dir1/b.h', '/dir2/c.h']) >>> h.add_macro('-DBOOST_LIB_NAME=boost_regex') >>> h.add_macro('-DBOOST_DYN_LINK') - >>> assert h.macro_definitions == '-DBOOST_LIB_NAME=boost_regex -DBOOST_DYN_LINK' # noqa + >>> h.macro_definitions + '-DBOOST_LIB_NAME=boost_regex -DBOOST_DYN_LINK' + + Returns: + str: A joined list of macro definitions """ return ' '.join(self._macro_definitions) @@ -715,13 +742,26 @@ class HeaderList(FileList): """Include flags + macro definitions >>> h = HeaderList(['/dir1/a.h', '/dir1/b.h', '/dir2/c.h']) + >>> h.cpp_flags + '-I/dir1 -I/dir2' >>> h.add_macro('-DBOOST_DYN_LINK') - >>> assert h.macro_definitions == '-I/dir1 -I/dir2 -DBOOST_DYN_LINK' + >>> h.cpp_flags + '-I/dir1 -I/dir2 -DBOOST_DYN_LINK' + + Returns: + str: A joined list of include flags and macro definitions """ - return self.include_flags + ' ' + self.macro_definitions + cpp_flags = self.include_flags + if self.macro_definitions: + cpp_flags += ' ' + self.macro_definitions + return cpp_flags def add_macro(self, macro): - """Add a macro definition""" + """Add a macro definition + + Parameters: + macro (str): The macro to add + """ self._macro_definitions.append(macro) @@ -775,6 +815,11 @@ class LibraryList(FileList): @property def libraries(self): + """Stable de-duplication of library files. + + Returns: + list of strings: A list of library files + """ return self.files @property @@ -782,7 +827,11 @@ class LibraryList(FileList): """Stable de-duplication of library names in the list >>> l = LibraryList(['/dir1/liba.a', '/dir2/libb.a', '/dir3/liba.so']) - >>> assert l.names == ['a', 'b'] + >>> l.names + ['a', 'b'] + + Returns: + list of strings: A list of library names """ return list(dedupe(x.split('.')[0][3:] for x in self.basenames)) @@ -791,7 +840,11 @@ class LibraryList(FileList): """Search flags for the libraries >>> l = LibraryList(['/dir1/liba.a', '/dir2/libb.a', '/dir1/liba.so']) - >>> assert l.search_flags == '-L/dir1 -L/dir2' + >>> l.search_flags + '-L/dir1 -L/dir2' + + Returns: + str: A joined list of search flags """ return ' '.join(['-L' + x for x in self.directories]) @@ -800,7 +853,11 @@ class LibraryList(FileList): """Link flags for the libraries >>> l = LibraryList(['/dir1/liba.a', '/dir2/libb.a', '/dir1/liba.so']) - >>> assert l.search_flags == '-la -lb' + >>> l.link_flags + '-la -lb' + + Returns: + str: A joined list of link flags """ return ' '.join(['-l' + name for name in self.names]) @@ -809,7 +866,11 @@ class LibraryList(FileList): """Search flags + link flags >>> l = LibraryList(['/dir1/liba.a', '/dir2/libb.a', '/dir1/liba.so']) - >>> assert l.search_flags == '-L/dir1 -L/dir2 -la -lb' + >>> l.ld_flags + '-L/dir1 -L/dir2 -la -lb' + + Returns: + str: A joined list of search flags and link flags """ return self.search_flags + ' ' + self.link_flags -- cgit v1.2.3-60-g2f50