Skip to content

Commit

Permalink
MAINT: Fix typo in public API
Browse files Browse the repository at this point in the history
By keeping both variants, we aim to full backwards compatibility.
The new variant does appear in the documentation, the mispelled
variant is missing from the documentation but has priority.
  • Loading branch information
DimitriPapadopoulos committed Sep 21, 2021
1 parent cd5c747 commit 5d9352b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
14 changes: 9 additions & 5 deletions numpy/ma/mrecords.py
Expand Up @@ -667,16 +667,17 @@ def openfile(fname):
raise NotImplementedError("Wow, binary file")


def fromtextfile(fname, delimitor=None, commentchar='#', missingchar='',
varnames=None, vartypes=None):
def fromtextfile(fname, delimiter=None, commentchar='#', missingchar='',
varnames=None, vartypes=None,
delimitor=None): # mispelled for backwards compatibility
"""
Creates a mrecarray from data stored in the file `filename`.
Parameters
----------
fname : {file name/handle}
Handle of an opened file.
delimitor : {None, string}, optional
delimiter : {None, string}, optional
Alphanumeric character used to separate columns in the file.
If None, any (group of) white spacestring(s) will be used.
commentchar : {'#', string}, optional
Expand All @@ -692,21 +693,24 @@ def fromtextfile(fname, delimitor=None, commentchar='#', missingchar='',
Ultra simple: the varnames are in the header, one line"""
if delimitor is not None:
delimiter = delimitor

# Try to open the file.
ftext = openfile(fname)

# Get the first non-empty line as the varnames
while True:
line = ftext.readline()
firstline = line[:line.find(commentchar)].strip()
_varnames = firstline.split(delimitor)
_varnames = firstline.split(delimiter)
if len(_varnames) > 1:
break
if varnames is None:
varnames = _varnames

# Get the data.
_variables = masked_array([line.strip().split(delimitor) for line in ftext
_variables = masked_array([line.strip().split(delimiter) for line in ftext
if line[0] != commentchar and len(line) > 1])
(_, nfields) = _variables.shape
ftext.close()
Expand Down
2 changes: 1 addition & 1 deletion numpy/ma/tests/test_mrecords.py
Expand Up @@ -468,7 +468,7 @@ def test_fromtextfile(self):
with temppath() as path:
with open(path, 'w') as f:
f.write(fcontent)
mrectxt = fromtextfile(path, delimitor=',', varnames='ABCDEFG')
mrectxt = fromtextfile(path, delimiter=',', varnames='ABCDEFG')
assert_(isinstance(mrectxt, MaskedRecords))
assert_equal(mrectxt.F, [1, 1, 1, 1])
assert_equal(mrectxt.E._mask, [1, 1, 1, 1])
Expand Down

0 comments on commit 5d9352b

Please sign in to comment.