v1.0.6

Author: mezantrop

README.md

@@ -14,14 +14,16 @@ pip install tssplit
 ### Syntax
 
 ```Python3
-def tssplit(s, quote='"\'', quote_keep=False, delimiter=':;,', escape='/^', trim=''):
+def tssplit(s, quote='"\'', quote_keep=False, delimiter=':;,', escape='/^', trim='', remark='#'):
     """Split a string by delimiters with quotes and escaped characters, optionally trimming results
+
     :param s: A string to split into chunks
     :param quote: Quote chars to protect a part of s from parsing
     :param quote_keep: Preserve quote characters in the output or not
     :param delimiter: A chunk separator character
     :param escape: An escape character
     :param trim: Trim characters from chunks
+    :param remark: Ignore all characters after remark sign
     :return: A list of chunks
     """
 ```
@@ -31,12 +33,17 @@ def tssplit(s, quote='"\'', quote_keep=False, delimiter=':;,', escape='/^', trim
 ```Python3
 from tssplit import tssplit
 
-tssplit('--:--;--,--"--/--"--\'--:--\'--/"--^--', quote='"\'', delimiter=':;,', escape='/^', trim='')
+tssplit('--:--;--,--"--/--"--\'--:--\'--/"--^--', 
+        quote='"\'', delimiter=':;,', escape='/^', trim='')
 ['--', '--', '--', '----/------:----"----']
 
-tssplit('--:--;--,--"--/--"--\'--:--\'--/"--^--', quote='"\'', delimiter=':;,', escape='/^', trim='', quote_keep=True)
+tssplit('--:--;--,--"--/--"--\'--:--\'--/"--^--', 
+        quote='"\'', delimiter=':;,', escape='/^', trim='', quote_keep=True)
 ['--', '--', '--', '--"--/--"--\'--:--\'--"----']
 
+tssplit('--:--;--,--"--/--"--\'--:--\'--# Ignore this', 
+        quote='"\'', delimiter=':;,', escape='/^', trim='', quote_keep=True, remark='#')
+['--', '--', '--', '--"--/--"--\'--:--\'--']
 ```
 
 ## Changelog
@@ -47,3 +54,4 @@ tssplit('--:--;--,--"--/--"--\'--:--\'--/"--^--', quote='"\'', delimiter=':;,',
 * 2020.03.29    v1.0.3  Trim option to strip() characters from chunks
 * 2020.03.29    v1.0.4  Multiple characters for quotes, delimiters and escapes
 * 2022.02.04    v1.0.5  Added `quote_keep` option to preserve quote marks in the output or not 
+* 2023.01.12    v1.0.6  Remark characters interrupt string parsing

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name='tssplit',
-    version='1.0.5',
+    version='1.0.6',
     py_modules=['tssplit.tssplit'],
     url='https://github.com/mezantrop/tssplit',
     license='bsd-2-clause',

tssplit/tssplit.py

@@ -1,4 +1,4 @@
-def tssplit(s, quote='"\'', quote_keep=False, delimiter=':;,', escape='/^', trim=''):
+def tssplit(s, quote='"\'', quote_keep=False, delimiter=':;,', escape='/^', trim='', remark='#'):
     """Split a string by delimiters with quotes and escaped characters, optionally trimming results
 
     :param s: A string to split into chunks
@@ -7,6 +7,7 @@ def tssplit(s, quote='"\'', quote_keep=False, delimiter=':;,', escape='/^', trim
     :param delimiter: A chunk separator character
     :param escape: An escape character
     :param trim: Trim characters from chunks
+    :param remark: Ignore all characters after remark sign
     :return: A list of chunks
     """
 
@@ -31,6 +32,8 @@ def tssplit(s, quote='"\'', quote_keep=False, delimiter=':;,', escape='/^', trim
                 token = token.strip(trim)
             result.append(token)
             token = ''
+        elif c in remark:
+            break
         else:
             token += c