Skip to content

Dialogs

openseize.file_io.dialogs

A collection of dialogs and message boxes.

This module contains the following functions 

    standard:
        A unified tkinter filedialog that gracefully destroys itself when
        a selection is complete or the window is closed.

    message:
        A unified tkinter messagebox that gracefully destroys itself when the
        window is closed.

    matching:
        A dialog that uses regex patterns to match file stems of two sets of
        file paths selected by path selection dialogs, or a directory dialog or
        by manually specifying a directory containing all paths to match.

openseize.file_io.dialogs.standard(kind, **options)

Opens a tkinter modal file dialog & returns a Path instance or list of Path instances.

Parameters:

Name Type Description Default
kind str

Name of a tkinter file dialog.

 required
options str
  • title (str): title of the dialog window
  • initialdir (str): dir dialog starts in
  • initialfile (str): file selected on dialog open
  • filetypes (seq): sequence of (label, pattern tuples) '*' with wildcard allowed
  • defaultextension (str): default ext to append during save dialogs
  • multiple (bool): when True multiple selection enabled
 {}

Returns:

Type Description
Union[Path, List[Path]]

A Path instance or list of Path instances.
Source code in openseize/file_io/dialogs.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
@root_deco
def standard(kind: str, **options: str) -> Union[Path, List[Path]]:
    """Opens a tkinter modal file dialog & returns a Path instance or list of
    Path instances.

    Args:
        kind:
            Name of a tkinter file dialog.
        options:
            - title (str):            title of the dialog window
            - initialdir (str):       dir dialog starts in
            - initialfile (str):      file selected on dialog open
            - filetypes (seq):        sequence of (label, pattern tuples) '*'
                                    with wildcard allowed
            - defaultextension (str): default ext to append during save dialogs
            - multiple (bool):        when True multiple selection enabled

    Returns:
        A Path instance or list of Path instances.
    """

    # disable parent placement since root_deco automates this
    options.pop('parent', None)
    paths = getattr(tkdialogs, kind)(**options)
    return Path(paths) if isinstance(paths, str) else [Path(p) for p in paths]

openseize.file_io.dialogs.message(kind, **options)

Opens a tkinter modal message box & returns a string response.

Parameters:

Name Type Description Default
kind str

Name of a tkinter messagebox (eg. 'askyesno')

 required
options str

Any valid option for the message box except for 'parent'.

 {}

Returns:

Type Description

A subset of (True, False, OK, None, Yes, No).
Source code in openseize/file_io/dialogs.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
@root_deco
def message(kind: str, **options: str):
    """Opens a tkinter modal message box & returns a string response.

    Args:
        kind:
            Name of a tkinter messagebox (eg. 'askyesno')
        options:
            Any valid option for the message box except for 'parent'.

    Returns:
        A subset of (True, False, OK, None, Yes, No).
    """

    #disable parent placement since root_deco automates this
    options.pop('parent', None)
    return getattr(tkmsgbox, kind)(**options)

openseize.file_io.dialogs.matching(pattern, kind=None, dirpath=None, **options)

A dialog that regex pattern matches Path stems of two sets of files.

This dialog can match two sets of files from two separate dialogs or match two sets of files contained in a single directory specified by a single dialog or a manually supplied directory path.

Parameters:

Name Type Description Default
pattern str

A regex pattern raw string used to perform match.

 required
kind Optional[str]

A string indicating if dialog should be of type 'askdirectory' or 'askopenfilenames'. If 'askdirectory' all the files to match must be in a single dir. If None a dirpath must be supplied.

 None
dirpath Optional[Union[str, Path]]

A optional path to a directory. If given, kind argument is ignored and no dialogs are opened. It is assumed that all paths to match are in the given dir.

 None
**options
  • initialdir (str): The dir to begin path selection. Default is current dir.
  • filetypes (list): sequence of (label, pattern tuples). The '*' wildcard allowed. This option is only valid if kind is 'askopenfilenames'.
 {}

Returns:

Type Description
List[Tuple[Path, Path]]

A list of matched path instance tuples.

Examples:

>>> # This example matches by directory without dialoging.
>>> import tempfile
>>> # make a temp dir containing 2 .edf & 2 .txt files
>>> tempdir = tempfile.mkdtemp()
>>> paths = [Path(tempdir).joinpath(x)
... for x in ['eeg_1.edf', 'eeg_2.edf']]
>>> others = [Path(tempdir).joinpath(x)
... for x in ['annotation_1.txt', 'annotation_2.txt']]
>>> x = [path.touch() for path in paths+others]
>>> # match the files stored in the dir
>>> result = matching(r'\d+', dirpath=Path(tempdir))
>>> # matching does not guarantee ordering so chk set equivalence
>>> set(result) == set(zip(paths, others))
True
Source code in openseize/file_io/dialogs.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def matching(pattern: str, kind: Optional[str] = None,
             dirpath: Optional[Union[str, Path]] = None, **options
) -> List[Tuple[Path, Path]]:
    r"""A dialog that regex pattern matches Path stems of two sets of files.

    This dialog can match two sets of files from two separate dialogs or
    match two sets of files contained in a single directory specified by
    a single dialog or a manually supplied directory path.

    Args:
        pattern:
            A regex pattern raw string used to perform match.
        kind:
            A string indicating if dialog should be of type 'askdirectory' or
            'askopenfilenames'. If 'askdirectory' all the files to match must be
            in a single dir. If None a dirpath must be supplied.
        dirpath:
            A optional path to a directory. If given, kind argument is ignored
            and no dialogs are opened. It is assumed that all paths to match
            are in the given dir.
        **options:
            - initialdir (str):     The dir to begin path selection. Default is
                                    current dir.
            - filetypes (list):     sequence of (label, pattern tuples). The '*'
                                    wildcard allowed. This option is only valid
                                    if kind is 'askopenfilenames'.
    Returns:
        A list of matched path instance tuples.

    Raises:
        A TypeError is raised if kind is not one of 'askdirectory' or
        'askopenfilenames' and the dirpath is None.

    Examples:
        >>> # This example matches by directory without dialoging.
        >>> import tempfile
        >>> # make a temp dir containing 2 .edf & 2 .txt files
        >>> tempdir = tempfile.mkdtemp()
        >>> paths = [Path(tempdir).joinpath(x)
        ... for x in ['eeg_1.edf', 'eeg_2.edf']]
        >>> others = [Path(tempdir).joinpath(x)
        ... for x in ['annotation_1.txt', 'annotation_2.txt']]
        >>> x = [path.touch() for path in paths+others]
        >>> # match the files stored in the dir
        >>> result = matching(r'\d+', dirpath=Path(tempdir))
        >>> # matching does not guarantee ordering so chk set equivalence
        >>> set(result) == set(zip(paths, others))
        True
    """

    if dirpath or kind == 'askdirectory':

        # dialog for dir if none given
        dirpath = standard(kind, **options) if not dirpath else Path(dirpath)
        # separate file paths in dirpat by suffix
        filepaths = dirpath.glob('*.*')
        sorted_paths = defaultdict(list)
        for path in filepaths:
            sorted_paths[path.suffix].append(path)
        paths, others = list(sorted_paths.values())

    elif kind == 'askopenfilenames':

        # open two dialogs to user select files to match
        paths = standard(kind, title='Select File Set 1', **options)
        others = standard(kind, title='Select File Set 2', **options)

    else:

        msg = ("matching dialog requires 'kind' argument to be one of '{}' "
                "or '{}' or a Path passed to the dirpath argument.")
        raise TypeError(msg.format('askdirectory', 'askopenfilenames'))

    return re_match(paths, others, pattern)