Skip to content

Commit 41d431d

Browse files
committed
Enhance README.md with detailed descriptions for integer, string, UUID, date, list, CVE, and CPE value objects, improving clarity on their validation and usage.
1 parent 0e9ec64 commit 41d431d

1 file changed

Lines changed: 44 additions & 2 deletions

File tree

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ A collection of Value Objects to save time by generalizing types and format vali
4848

4949
### Int
5050

51-
Integer numbers without a fractional component that don't support decimal points.
51+
A basic integer value object that ensures the value is a valid integer without decimal points. It provides type safety and validation for integer values.
5252

5353
```python
5454
from pyvalueobjects import Int
@@ -62,7 +62,7 @@ my_integer.value() # returns -> 9
6262

6363
### Nullable Int
6464

65-
Integer numbers and None.
65+
An integer value object that can also be None, useful for optional numeric fields. It provides the same validation as Int but allows for null values.
6666

6767
```python
6868
from pyvalueobjects import NullableInt
@@ -80,6 +80,8 @@ my_nullable_integer.value() # returns -> None
8080

8181
### Positive Int
8282

83+
An integer value object that ensures the value is strictly greater than zero. Useful for representing quantities, counts, or any value that must be positive.
84+
8385
```python
8486
from pyvalueobjects import PositiveInt
8587

@@ -92,6 +94,8 @@ my_integer.value() # returns -> 9
9294

9395
### Nullable Positive Int
9496

97+
A positive integer value object that can also be None. Combines the validation of PositiveInt with the flexibility of nullable values.
98+
9599
```python
96100
from pyvalueobjects import NullablePositiveInt
97101

@@ -108,6 +112,8 @@ my_nullable_integer.value() # returns -> None
108112

109113
### Positive Or Zero Int
110114

115+
An integer value object that ensures the value is greater than or equal to zero. Useful for representing non-negative quantities or counts.
116+
111117
```python
112118
from pyvalueobjects import PositiveOrZeroInt
113119

@@ -120,6 +126,8 @@ my_integer.value() # returns -> 9
120126

121127
### Nullable Positive Or Zero Int
122128

129+
A non-negative integer value object that can also be None. Combines the validation of PositiveOrZeroInt with the flexibility of nullable values.
130+
123131
```python
124132
from pyvalueobjects import NullablePositiveOrZeroInt
125133

@@ -136,6 +144,8 @@ my_nullable_integer.value() # returns -> None
136144

137145
### Negative Int
138146

147+
An integer value object that ensures the value is strictly less than zero. Useful for representing negative quantities or values.
148+
139149
```python
140150
from pyvalueobjects import NegativeInt
141151

@@ -148,6 +158,8 @@ my_integer.value() # returns -> -9
148158

149159
### Nullable Negative Int
150160

161+
A negative integer value object that can also be None. Combines the validation of NegativeInt with the flexibility of nullable values.
162+
151163
```python
152164
from pyvalueobjects import NullableNegativeInt
153165

@@ -164,6 +176,8 @@ my_nullable_integer.value() # returns -> None
164176

165177
### Negative Or Zero Int
166178

179+
An integer value object that ensures the value is less than or equal to zero. Useful for representing non-positive quantities or values.
180+
167181
```python
168182
from pyvalueobjects import NegativeOrZeroInt
169183

@@ -176,6 +190,8 @@ my_integer.value() # returns -> -9
176190

177191
### Nullable Negative Or Zero Int
178192

193+
A non-positive integer value object that can also be None. Combines the validation of NegativeOrZeroInt with the flexibility of nullable values.
194+
179195
```python
180196
from pyvalueobjects import NullableNegativeOrZeroInt
181197

@@ -194,6 +210,8 @@ my_nullable_integer.value() # returns -> None
194210

195211
### String
196212

213+
A basic string value object that ensures the value is a valid string. Provides type safety and validation for string values.
214+
197215
```python
198216
from pyvalueobjects import String
199217

@@ -206,6 +224,8 @@ my_str.value() # returns -> 'potato'
206224

207225
### Nullable String
208226

227+
A string value object that can also be None. Useful for optional string fields.
228+
209229
```python
210230
from pyvalueobjects import NullableString
211231

@@ -224,6 +244,8 @@ my_nullable_str.value() # returns -> None
224244

225245
### Non Empty String
226246

247+
A string value object that ensures the value is not an empty string. Useful for required string fields that must contain content.
248+
227249
```python
228250
from pyvalueobjects import NonEmptyString
229251

@@ -239,6 +261,8 @@ my_str2 = NonEmptyString('') # raises error
239261

240262
### Nullable non Empty String
241263

264+
A non-empty string value object that can also be None. Combines the validation of NonEmptyString with the flexibility of nullable values.
265+
242266
```python
243267
from pyvalueobjects import NullableNonEmptyString
244268

@@ -260,6 +284,8 @@ my_str3 = NullableNonEmptyString('') # raises error
260284

261285
### Uuid4
262286

287+
A string value object that ensures the value is a valid UUID v4 format. Useful for representing unique identifiers.
288+
263289
```python
264290
from pyvalueobjects import Uuid4
265291

@@ -272,6 +298,8 @@ my_uuid4.value() # returns -> '6c7add12-bf35-459e-a6c5-3178a2a33011'
272298

273299
### Nullable Uuid4
274300

301+
A UUID v4 value object that can also be None. Combines the validation of Uuid4 with the flexibility of nullable values.
302+
275303
```python
276304
from pyvalueobjects import NullableUuid4
277305

@@ -288,6 +316,8 @@ my_null_uuid4.value() # returns -> 'None'
288316

289317
### ISO Date
290318

319+
A string value object that ensures the value is a valid ISO 8601 date format. Useful for representing dates and timestamps in a standardized format.
320+
291321
```python
292322
from pyvalueobjects import IsoDate
293323

@@ -302,6 +332,8 @@ my_date.value() # returns -> '2023-08-15T04:55:12.076Z'
302332

303333
### ArrayList
304334

335+
A value object that ensures all elements in a list are of a specific type. Provides type safety and validation for list contents.
336+
305337
```python
306338
from pyvalueobjects import ArrayList
307339
from pyvalueobjects import Int
@@ -315,6 +347,8 @@ my_int_array.value() # returns -> [39]
315347

316348
### Nullable ArrayList
317349

350+
A list value object that can also be None, with type validation for its elements. Combines the validation of ArrayList with the flexibility of nullable values.
351+
318352
```python
319353
from pyvalueobjects import ArrayList
320354
from pyvalueobjects import Int
@@ -332,6 +366,8 @@ my_null_array.value() # returns -> None
332366

333367
### CVE
334368

369+
A string value object that ensures the value is a valid Common Vulnerabilities and Exposures (CVE) identifier format. Useful for representing security vulnerability identifiers.
370+
335371
```python
336372
from pyvalueobjects import Cve
337373

@@ -344,6 +380,8 @@ my_cve.value() # returns -> 'CVE-2014-9418'
344380

345381
### Nullable CVE
346382

383+
A CVE value object that can also be None. Combines the validation of CVE with the flexibility of nullable values.
384+
347385
```python
348386
from pyvalueobjects import NullableCve
349387

@@ -358,6 +396,8 @@ my_null_cve.value() # returns -> None
358396

359397
### CPE
360398

399+
A string value object that ensures the value is a valid Common Platform Enumeration (CPE) format. Useful for representing platform and software identifiers.
400+
361401
```python
362402
from pyvalueobjects import Cpe
363403

@@ -370,6 +410,8 @@ my_cpe.value() # returns -> 'cpe:/a:openjdk:openjdk:8u282'
370410

371411
### Nullable CPE
372412

413+
A CPE value object that can also be None. Combines the validation of CPE with the flexibility of nullable values.
414+
373415
```python
374416
from pyvalueobjects import NullableCpe
375417

0 commit comments

Comments
 (0)