def test_type(copy_fortran_file):
"""Check that types can be read"""
data = """\
program foo
!! base type
type :: base
end type base
!! derived type
type, extends(base) :: derived
end type
"""
expected = [
"program foo",
"!! base type",
"type :: base",
"end type base",
"!! derived type",
"type, extends(base) :: derived",
"end type",
]
filename = copy_fortran_file(data)
lines = list(reader.FortranReader(filename, docmark="!"))
assert lines == expected
def test_reader_test_data(self):
f_files = glob.glob('./test_data/*.f*')
f_files = [
f for f in f_files
if not 'expected' in f # remove 'expected' files
and not 'bad' in f
] # remove 'bad files'
#create_expected=True
create_expected = False
for ff in f_files:
ee = ff.replace('.f90', '_expected.f90')
print('\tProcessing: %s \tExpected: %s ' % (ff, ee))
lines = [
line for line in reader.FortranReader(ff,
docmark='!',
predocmark='>',
docmark_alt='#',
predocmark_alt='<')
]
if create_expected:
print('WARNING : Writing expected file ' + ee)
with open(ee, 'w') as ef:
for line in lines:
print(line)
ef.write(line + '\n')
else:
with open(ee) as ef:
lines = remove_multiple_white_space(lines)
elines = remove_multiple_white_space(ef.readlines())
self.assertEqual(lines, elines)
def test_reader_test_data():
"""Basic regression test"""
f_files = glob.glob("./test_data/*.f*")
f_files = [
f for f in f_files if "expected" not in f
and "bad" not in f # remove 'expected' and 'bad' files
]
# Set to True to update the 'expected' files
create_expected = False
for ff in f_files:
ee = ff.replace(".f90", "_expected.f90")
print("\tProcessing: %s \tExpected: %s " % (ff, ee))
lines = [
line for line in reader.FortranReader(ff,
docmark="!",
predocmark=">",
docmark_alt="#",
predocmark_alt="<")
]
if create_expected:
print("WARNING : Writing expected file " + ee)
with open(ee, "w") as ef:
for line in lines:
print(line)
ef.write(line + "\n")
else:
with open(ee) as ef:
lines = remove_multiple_white_space(lines)
elines = remove_multiple_white_space(ef.readlines())
assert lines == elines
def test_multiline_string(copy_fortran_file):
"""Check that we can continue string literals including exclamation
marks over multiple lines. Issue #320"""
data = '''\
program multiline_string
implicit none
print*, 'dont''t', " get ""!>quotes!@""", " '""!<wrong!!""' ", "foo&
&bar! foo&
&bar"
end program multiline_string
'''
filename = copy_fortran_file(data)
expected = [
"program multiline_string",
"implicit none",
'''print*, 'dont''t', " get ""!>quotes!@""", " '""!<wrong!!""' ", "foobar! foobar"''',
"end program multiline_string",
]
lines = list(
reader.FortranReader(filename,
docmark="!",
predocmark="<",
docmark_alt=">",
predocmark_alt="@"))
assert lines == expected
def test_type(tmp_path):
"""Check that types can be read"""
data = """\
program foo
!! base type
type :: base
end type base
!! derived type
type, extends(base) :: derived
end type
"""
expected = [
"program foo",
"!! base type",
"type :: base",
"end type base",
"!! derived type",
"type, extends(base) :: derived",
"end type",
]
filename = tmp_path / "test.f90"
with open(filename, "w") as f:
f.write(data)
lines = list(reader.FortranReader(filename, docmark="!"))
assert lines == expected
def test_reader_continuation(copy_fortran_file):
"""Checks that line continuations are handled correctly"""
data = """\
program foo
!! some docs
integer :: bar = &
&
4
end
"""
filename = copy_fortran_file(data)
lines = list(reader.FortranReader(filename, docmark="!"))
assert lines == [
"program foo", "!! some docs", "integer :: bar = 4", "end"
]
def test_preprocessor(copy_fortran_file):
"""Check some basic preprocessing is applied"""
data = """\
subroutine SUB_NAME()
end sub_name SUB_NAME
"""
filename = copy_fortran_file(data, ".F90")
lines = "\n".join(
list(
reader.FortranReader(
str(filename),
preprocessor=["cpp", "-traditional-cpp", "-E"],
macros=["SUB_NAME=foo"],
)))
assert "foo" in lines
def test_preprocessor_warning(copy_fortran_file):
"""Check preprocessing is still done even if there are warnings"""
data = """\
#warning something
subroutine SUB_NAME()
end sub_name SUB_NAME
"""
filename = copy_fortran_file(data, ".F90")
lines = "\n".join(
list(
reader.FortranReader(
str(filename),
preprocessor=["cpp", "-traditional-cpp", "-E"],
macros=["SUB_NAME=foo"],
)))
assert "foo" in lines
def test_unknown_include(copy_fortran_file):
"""Check that `include "file.h"` ignores unknown files"""
data = """\
program test
include "file.h"
end program test
"""
expected = [
"program test",
'include "file.h"',
"end program test",
]
filename = copy_fortran_file(data)
lines = list(reader.FortranReader(filename, docmark="!"))
assert lines == expected
def test_reader_continuation(tmp_path):
"""Checks that line continuations are handled correctly"""
data = """\
program foo
!! some docs
integer :: bar = &
&
4
end
"""
filename = tmp_path / "test.f90"
with open(filename, "w") as f:
f.write(data)
lines = list(reader.FortranReader(filename, docmark="!"))
assert lines == [
"program foo", "!! some docs", "integer :: bar = 4", "end"
]
def test_unknown_include(tmp_path):
"""Check that `include "file.h"` ignores unknown files"""
data = """\
program test
include "file.h"
end program test
"""
expected = [
"program test",
'include "file.h"',
"end program test",
]
filename = tmp_path / "test.f90"
with open(filename, "w") as f:
f.write(data)
lines = list(reader.FortranReader(filename, docmark="!"))
assert lines == expected