Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add ignore_comments to documentation #495

Merged
merged 1 commit into from
Nov 8, 2021
Merged

Add ignore_comments to documentation #495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/source/header-section.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,19 @@ Handling special cases of header lines
lasio will do its best to read every line from the header section. Some examples
follow for unusual formattings:

Comment lines mixed with header lines
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

lasio will, by default, treat header lines starting with a "#" hash string as a
comment line and ignore it. Spaces before the "#" are stripped off before
checking for the "#".

To modify which strings indicate comment lines to ignore pass an
ignore_comments tuple to ``lasio.read()`` or ``lasio.examples.open()``.

Example:
``lasio.read(file, ignore_comments=("#", "%MyComment")``

Lines without periods
~~~~~~~~~~~~~~~~~~~~~

Expand Down
6 changes: 3 additions & 3 deletions lasio/las.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ def read(
file_obj,
(first_line, last_line),
regexp_subs,
ignore_comments=ignore_data_comments,
ignore_data_comments=ignore_data_comments,
)

# How many curves should the reader attempt to find?
Expand Down Expand Up @@ -370,7 +370,7 @@ def read(
(first_line, last_line),
regexp_subs,
value_null_subs,
ignore_comments=ignore_data_comments,
ignore_data_comments=ignore_data_comments,
n_columns=reader_n_columns,
dtypes=dtypes,
line_splitter=line_splitter,
Expand All @@ -392,7 +392,7 @@ def read(
(first_line, last_line),
regexp_subs,
value_null_subs,
ignore_comments=ignore_data_comments,
ignore_data_comments=ignore_data_comments,
n_columns=reader_n_columns,
dtypes=dtypes,
line_splitter=line_splitter,
Expand Down
16 changes: 8 additions & 8 deletions lasio/reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ def determine_section_type(section_title):
return "Header items"


def inspect_data_section(file_obj, line_nos, regexp_subs, ignore_comments="#"):
def inspect_data_section(file_obj, line_nos, regexp_subs, ignore_data_comments="#"):
"""Determine how many columns there are in the data section.

Arguments:
Expand All @@ -352,7 +352,7 @@ def inspect_data_section(file_obj, line_nos, regexp_subs, ignore_comments="#"):
regexp_subs (list): each item should be a tuple of the pattern and
substitution string for a call to re.sub() on each line of the
data section. See defaults.py READ_SUBS and NULL_SUBS for examples.
ignore_comments (str): lines beginning with this character will be ignored
ignore_data_comments (str): lines beginning with this character will be ignored

Returns: integer number of columns or -1 where they are different.

Expand All @@ -366,7 +366,7 @@ def inspect_data_section(file_obj, line_nos, regexp_subs, ignore_comments="#"):
for i, line in enumerate(file_obj):
line_no = line_no + 1
line = line.strip("\n").strip()
if line.strip().startswith(ignore_comments):
if line.strip().startswith(ignore_data_comments):
continue
else:
for pattern, sub_str in regexp_subs:
Expand Down Expand Up @@ -395,7 +395,7 @@ def read_data_section_iterative_normal_engine(
line_nos,
regexp_subs,
value_null_subs,
ignore_comments,
ignore_data_comments,
n_columns,
dtypes,
line_splitter,
Expand All @@ -410,7 +410,7 @@ def read_data_section_iterative_normal_engine(
data section. See defaults.py READ_SUBS and NULL_SUBS for examples.
value_null_subs (list): list of numerical values to be replaced by
numpy.nan values.
ignore_comments (str): lines beginning with this character will be ignored
ignore_data_comments (str): lines beginning with this character will be ignored
n_columns (int): expected number of columns
dtypes (list, "auto", False): list of expected data types for each column,
(each data type can be specified as e.g. `int`,
Expand All @@ -433,7 +433,7 @@ def read_data_section_iterative_normal_engine(
def items(f, start_line_no, end_line_no):
for line_no, line in enumerate(f, start=start_line_no+1):
line = line.strip("\n").strip()
if line.startswith(ignore_comments):
if line.startswith(ignore_data_comments):
continue
else:
for pattern, sub_str in regexp_subs:
Expand Down Expand Up @@ -668,8 +668,8 @@ def parse_header_items_section(
mnemonic_case (str): 'preserve': keep the case of HeaderItem mnemonics
'upper': convert all HeaderItem mnemonics to uppercase
'lower': convert all HeaderItem mnemonics to lowercase
ignore_comments (False, True, or list): ignore lines starting with these
characters; by default True as '#'.
ignore_comments (list): ignore lines starting with these characters; by
default '#'.

Returns:
:class:`lasio.SectionItems`
Expand Down