add configparser options #17

emar-kar · 2023-01-28T04:08:13Z

This PR adds options which are available in python ConfigParser constructor.

List of added options:

Delimiters - allows to set custom key-value pair delimiters.
CommentPrefixes - allows to set custom comment line prefix. If line starts with one of the given Prefixes it will be passed during parsing.
InlineCommentPrefixes - allows to set custom inline comment delimiter. This option checks if the line contains any of the given Prefixes and if so, splits the string by the prefix and returns the 0 index of the slice.
MultilinePrefixes - allows to set custom multiline values prefixes. This option checks if the line starts with one of the given Prefixes and if so, counts it as a part of the current value.
Strict - if set to true, parser will return error for duplicates of sections or options in one source.
AllowEmptyLines - if set to true allows multiline values to include empty lines as their part. Otherwise the value will be parsed until an empty line or the line which does not start with one of the allowed multiline prefixes.
Interpolation - allows to set custom behaviour for values interpolation. Interface was added, which defaults to chainmap.ChainMap instance.

type Interpolator interface {
	Add(...chainmap.Dict)
	Len() int
	Get(string) string
}

Converters - allows to set custom values parsers.

type ConvertFunc func(string) (any, error)

ConvertFunc can modify requested value if needed e.g.,

package main

import (
	"fmt"
	"strings"

	"github.com/bigkevmcd/go-configparser"
)

func main() {
	stringConv := func(s string) (any, error) {
		return s + "_updated", nil
	}

	conv := configparser.Converter{
		configparser.String: stringConv,
	}

	p, err := configparser.ParseReaderWithOptions(
		strings.NewReader("[section]\noption=value\n\n"),
		configparser.Converters(conv),
	)
	// handle err

	v, err := p.Get("section", "option")
	// handle err

	fmt.Println(v == "value_updated") // true
}

Those functions triggered inside ConfigParser.Get* methods if presented and wraps the return value.

NOTE: Since ConvertFunc returns any, the caller should guarantee type assertion to the requested type after custom processing!

type Converter map[string]ConvertFunc

Converter is a map type, which supports int (for int64), string, bool, float (for float64) keys.

Default options, which are always preset:

func defaultOptions() *options {
	return &options{
		interpolation:     chainmap.New(),
		defaultSection:    defaultSectionName,
		delimiters:        ":=",
		commentPrefixes:   Prefixes{"#", ";"},
		multilinePrefixes: Prefixes{"\t", " "},
		converters: Converter{
			StringConv: defaultGet,
			IntConv:    defaultGetInt64,
			FloatConv:  defaultGetFloat64,
			BoolConv:   defaultGetBool,
		},
	}
}

* update keyValue regexp * add check if section was found before parsing keyValue * update value slice index * add tests

* add Options to control Parser behavior * add NewWithOptions * add ParseReaderWithOptions * add ParseWithOptions moved main parser logic into configparser.ParseReader

* interpolation * commentPrefixes * inlineCommentPrefixes * defaultSection * delimeters * converters * strict TODO: investigate `emptyLines` realisation

bigkevmcd · 2023-01-29T11:49:23Z

I do want to land these changes, I just need to find some time to read over them.

emar-kar · 2023-01-29T18:31:23Z

I do want to land these changes, I just need to find some time to read over them.

I still do some things here and there

emar-kar · 2023-02-02T19:36:48Z

options.go

+	strict                bool
+
+	// TODO: under investigation, have no effect now.
+	emptyLines bool


@bigkevmcd I was thinking recently about this option, and actually I think it can be implemented, but in this case we will need to change the basics of the file parser. Since it's related to #14 issue, the process of parsing the multiline values should be added first. In this case, I would like to leave it as it is right now and come back to it after those changes will be reviewed

I will make time over the weekend to review this and move it forward

I added multiline value support and empty lines flag

bigkevmcd

This looks good to me, some small changes, but otherwise, I'm happy enough with this.

bigkevmcd · 2023-02-11T08:27:22Z

configparser.go

+				curSect = newSection(section)
+				p.config[section] = curSect
+			} else if p.opt.strict {
+				return fmt.Errorf("section %q error: %w", section, ErrAlreadyExist)


I'm not sure wrapping a sentinel error is the right way to do this.

I'd be inclined to define an AlreadyExistsError type, which can contain the section with .Error() string which would return this message.

Take a look at the stdlib PathError for an example.

Hm, I also use it here to report duplicate option. As I see PathError still have error field and Unwrap method and Op. Is it worth it to make the whole new structure for the error which actually can be triggered twice? Imho wrapped error is more informative, but at the same time can be easily unwrapped in the user code to assert it with errors.Is

I've removed wrapped error and let it be just text description, without any specific type

bigkevmcd · 2023-02-11T08:30:02Z

options.go

+type Prefixes []string
+
+// AtFirst checks if str starts with any of the prefixes.
+func (pr Prefixes) AtFirst(str string) bool {


How about just MatchesPrefix for this? or even HasPrefix ?

AtFirst doesn't really say what this does?

bigkevmcd · 2023-02-11T08:39:09Z

options.go

+func (pr Prefixes) Split(str string) string {
+	for _, p := range pr {
+		if strings.Contains(str, p) {
+			return strings.Split(str, p)[0]


Given that these are prefixes, should this use HasPrefix ?

This function is used for inline comments e.g. option = value # this is a comment. Thus, here it checks if given string contains any of the Prefixes

bigkevmcd · 2023-02-11T08:46:05Z

chainmap/chainmap.go

@@ -15,6 +15,10 @@ func New(dicts ...Dict) *ChainMap {
 	return chainMap
 }

+func (c *ChainMap) Add(dicts ...Dict) {


This is exported and should have a doc comment?

emar-kar · 2023-02-11T11:35:32Z

@bigkevmcd should we add some info on the options usage in readme file? Like the same text in the MR description?

emar-kar · 2023-04-16T23:18:01Z

@bigkevmcd any updates on this one?

bigkevmcd · 2023-04-17T10:50:38Z

@emar-kar Apologies, I'll get to it this week.

if section name equals default section name in options, then return default items instead of error

emar-kar · 2023-04-27T03:00:10Z

Recent updates will close both #14 and #18 issues

bigkevmcd

@emar-kar Thanks for this, looks good.

emar-kar added 7 commits January 23, 2023 21:32

add option with no value parsing

beeda05

* update keyValue regexp * add check if section was found before parsing keyValue * update value slice index * add tests

add AllowNoValue option

05dc3df

update config file

a233611

update configparser test

2eb406a

update with suggested Options:

0ff251a

* add Options to control Parser behavior * add NewWithOptions * add ParseReaderWithOptions * add ParseWithOptions moved main parser logic into configparser.ParseReader

switched options to func

d6c4d4e

add list of new options

5b4759d

* interpolation * commentPrefixes * inlineCommentPrefixes * defaultSection * delimeters * converters * strict TODO: investigate `emptyLines` realisation

emar-kar marked this pull request as draft January 28, 2023 04:09

emar-kar added 6 commits January 28, 2023 04:18

restore chainmap for back compatability

fdfd266

update chainmap

4237ebc

remove doc string

962cdb1

renames

cfa8805

fix typo

f683bf5

upd sectionHeader to match inline comments

dc2303d

emar-kar commented Feb 2, 2023

View reviewed changes

emar-kar marked this pull request as ready for review February 2, 2023 19:39

emar-kar mentioned this pull request Feb 2, 2023

add option with no value #16

Closed

emar-kar changed the title ~~add new options~~ add configparser options Feb 2, 2023

bigkevmcd requested changes Feb 11, 2023

View reviewed changes

emar-kar added 2 commits February 11, 2023 11:32

rename AtFirst to HasPrefix

c2f3f71

update docs

5aa8ea2

emar-kar added 4 commits February 11, 2023 12:13

add converter to default and simplify the process

c0d0c6a

update readme

18e4c52

update docs

0cafa2c

update naming

9f64e87

emar-kar added 12 commits April 27, 2023 03:46

add multilinePrefixes and emptyLines to options

05be35c

upd parser with multiline and emptylines in values

33107d2

update parser Items func

9228a00

if section name equals default section name in options, then return default items instead of error

update readme with new options

468c00e

add custom interpolator into options test

f2b017d

add new test: TestStrictOptDuplicateEmptyValue

b4af223

add new test: TestAllowEmptyLines

446fd99

add docs to options tests

2587089

add new test: TestMultilineValue

7b085c3

update test TestParseFromReader with assertions

13a300f

add new test: TestMultilinePrefixes

f1412d2

update test: TestAllowEmptyLines

c97a0fb

emar-kar added 2 commits April 27, 2023 04:02

fix docs typo

986bd0c

remove ErrAlreadyExist

4f9109c

bigkevmcd approved these changes Apr 27, 2023

View reviewed changes

bigkevmcd merged commit 380708e into bigkevmcd:main Apr 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add configparser options #17

add configparser options #17

emar-kar commented Jan 28, 2023 •

edited

Loading

bigkevmcd commented Jan 29, 2023

emar-kar commented Jan 29, 2023 •

edited

Loading

emar-kar Feb 2, 2023

bigkevmcd Feb 3, 2023

emar-kar Apr 27, 2023 •

edited

Loading

bigkevmcd left a comment

bigkevmcd Feb 11, 2023

emar-kar Feb 11, 2023

emar-kar Apr 27, 2023

bigkevmcd Feb 11, 2023

bigkevmcd Feb 11, 2023

emar-kar Feb 11, 2023

bigkevmcd Feb 11, 2023

emar-kar commented Feb 11, 2023

emar-kar commented Apr 16, 2023

bigkevmcd commented Apr 17, 2023

emar-kar commented Apr 27, 2023

bigkevmcd left a comment

add configparser options #17

add configparser options #17

Conversation

emar-kar commented Jan 28, 2023 • edited Loading

bigkevmcd commented Jan 29, 2023

emar-kar commented Jan 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emar-kar Apr 27, 2023 • edited Loading

Choose a reason for hiding this comment

bigkevmcd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emar-kar commented Feb 11, 2023

emar-kar commented Apr 16, 2023

bigkevmcd commented Apr 17, 2023

emar-kar commented Apr 27, 2023

bigkevmcd left a comment

Choose a reason for hiding this comment

emar-kar commented Jan 28, 2023 •

edited

Loading

emar-kar commented Jan 29, 2023 •

edited

Loading

emar-kar Apr 27, 2023 •

edited

Loading