Skip to content

Commit

Permalink
Merge pull request #20 from openfun/optional-values
Browse files Browse the repository at this point in the history
Use None as default value for each Optional parameter
  • Loading branch information
hexatester authored Oct 11, 2024
2 parents 69a1af3 + ab73c7e commit 1c7a995
Show file tree
Hide file tree
Showing 46 changed files with 510 additions and 510 deletions.
38 changes: 19 additions & 19 deletions moodle/auth/email/signup_setting.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,27 +31,27 @@ class ProfileField:
param5 (Optional[str]): Profield field settings
"""

id: Optional[int]
shortname: Optional[str]
name: Optional[str]
datatype: Optional[str]
description: Optional[str]
descriptionformat: int
categoryid: Optional[int]
categoryname: Optional[str]
sortorder: Optional[int]
required: Optional[int]
locked: Optional[int]
visible: Optional[int]
forceunique: Optional[int]
signup: Optional[int]
defaultdata: Optional[str]
defaultdataformat: int
param1: Optional[str]
param2: Optional[str]
param3: Optional[str]
param4: Optional[str]
param5: Optional[str]
id: Optional[int] = None
shortname: Optional[str] = None
name: Optional[str] = None
datatype: Optional[str] = None
description: Optional[str] = None
categoryid: Optional[int] = None
categoryname: Optional[str] = None
sortorder: Optional[int] = None
required: Optional[int] = None
locked: Optional[int] = None
visible: Optional[int] = None
forceunique: Optional[int] = None
signup: Optional[int] = None
defaultdata: Optional[str] = None
param1: Optional[str] = None
param2: Optional[str] = None
param3: Optional[str] = None
param4: Optional[str] = None
param5: Optional[str] = None


@dataclass
Expand Down
4 changes: 2 additions & 2 deletions moodle/base/warning.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@

@dataclass
class MoodleWarning:
item: Optional[str]
itemid: Optional[int]
warningcode: str
message: str
item: Optional[str] = None
itemid: Optional[int] = None

def __str__(self) -> str:
return self.message
Expand Down
4 changes: 2 additions & 2 deletions moodle/block/starred_course.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ class StarredCourse:
fullnamedisplay: str
viewurl: str
courseimage: str
progress: Optional[int]
hasprogress: int
isfavourite: int
hidden: int
timeaccess: Optional[int]
showshortname: int
coursecategory: str
progress: Optional[int] = None
timeaccess: Optional[int] = None
70 changes: 35 additions & 35 deletions moodle/core/badges/badge.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ class BagdeAlignment:
targetCode (Optional[str]): Target code
"""

id: Optional[int]
badgeid: Optional[int]
targetName: Optional[str]
targetUrl: Optional[str]
targetDescription: Optional[str]
targetFramework: Optional[str]
targetCode: Optional[str]
id: Optional[int] = None
badgeid: Optional[int] = None
targetName: Optional[str] = None
targetUrl: Optional[str] = None
targetDescription: Optional[str] = None
targetFramework: Optional[str] = None
targetCode: Optional[str] = None


@dataclass
Expand All @@ -63,9 +63,9 @@ class RelatedBadge:

id: int
name: str
version: Optional[str]
language: Optional[str]
type: Optional[int]
version: Optional[str] = None
language: Optional[str] = None
type: Optional[int] = None


@dataclass
Expand Down Expand Up @@ -110,42 +110,42 @@ class Badge:
relatedbadges (List[RelatedBadge]): Related badges
"""

id: Optional[int]
name: str
description: str
timecreated: Optional[int]
timemodified: Optional[int]
usercreated: Optional[int]
usermodified: Optional[int]
issuername: str
issuerurl: str
issuercontact: str
expiredate: Optional[int]
expireperiod: Optional[int]
type: Optional[int]
courseid: Optional[int]
message: Optional[str]
messagesubject: Optional[str]
attachment: Optional[int]
notification: Optional[int]
nextcron: Optional[int]
status: Optional[int]
issuedid: Optional[int]
uniquehash: str
dateissued: int
dateexpire: Optional[int]
visible: Optional[int]
email: Optional[str]
version: Optional[str]
language: Optional[str]
imageauthorname: Optional[str]
imageauthoremail: Optional[str]
imageauthorurl: Optional[str]
imagecaption: Optional[str]
badgeurl: str
endorsement: Optional[BagdeEndorsement] = None
alignment: List[BagdeAlignment] = field(factory=list)
relatedbadges: List[RelatedBadge] = field(factory=list)
id: Optional[int] = None
timecreated: Optional[int] = None
timemodified: Optional[int] = None
usercreated: Optional[int] = None
usermodified: Optional[int] = None
expiredate: Optional[int] = None
expireperiod: Optional[int] = None
type: Optional[int] = None
courseid: Optional[int] = None
message: Optional[str] = None
messagesubject: Optional[str] = None
attachment: Optional[int] = None
notification: Optional[int] = None
nextcron: Optional[int] = None
status: Optional[int] = None
issuedid: Optional[int] = None
dateexpire: Optional[int] = None
visible: Optional[int] = None
email: Optional[str] = None
version: Optional[str] = None
language: Optional[str] = None
imageauthorname: Optional[str] = None
imageauthoremail: Optional[str] = None
imageauthorurl: Optional[str] = None
imagecaption: Optional[str] = None


@dataclass
Expand Down
24 changes: 12 additions & 12 deletions moodle/core/block/block.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ class BlockFile:
param: repositorytype (Optional[str]): The repository type for external files
"""

filename: Optional[str]
filepath: Optional[str]
filesize: Optional[int]
fileurl: Optional[str]
timemodified: Optional[int]
mimetype: Optional[str]
isexternalfile: Optional[int]
repositorytype: Optional[str]
filename: Optional[str] = None
filepath: Optional[str] = None
filesize: Optional[int] = None
fileurl: Optional[str] = None
timemodified: Optional[int] = None
mimetype: Optional[str] = None
isexternalfile: Optional[int] = None
repositorytype: Optional[str] = None


@dataclass
Expand All @@ -42,7 +42,7 @@ class BlockContent:
title: str
content: str
contentformat: int
footer: Optional[str]
footer: Optional[str] = None
files: List[BlockFile] = field(factory=list)

def __str__(self) -> str:
Expand All @@ -67,12 +67,12 @@ class Block:
instanceid: int
name: str
region: str
positionid: Optional[int]
collapsible: bool
dockable: bool
weight: Optional[int]
visible: bool
contents: Optional[BlockContent]
positionid: Optional[int] = None
weight: Optional[int] = None
contents: Optional[BlockContent] = None

def __str__(self) -> str:
return self.name
Expand Down
36 changes: 18 additions & 18 deletions moodle/core/blog/blog_entry.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ class BlogSummaryFiles:
param: repositorytype (Optional[str]): The repository type for the external files.
"""

filename: Optional[str]
filepath: Optional[str]
filesize: Optional[int]
fileurl: Optional[str]
timemodified: Optional[int]
mimetype: Optional[str]
isexternalfile: Optional[int]
repositorytype: Optional[str]
filename: Optional[str] = None
filepath: Optional[str] = None
filesize: Optional[int] = None
fileurl: Optional[str] = None
timemodified: Optional[int] = None
mimetype: Optional[str] = None
isexternalfile: Optional[int] = None
repositorytype: Optional[str] = None


@dataclass
Expand All @@ -43,14 +43,14 @@ class BlogAttachmentFile:
param: repositorytype: (Optional[str]): The repository type for the external files.
"""

filename: Optional[str]
filepath: Optional[str]
filesize: Optional[int]
fileurl: Optional[str]
timemodified: Optional[int]
mimetype: Optional[str]
isexternalfile: Optional[int]
repositorytype: Optional[str]
filename: Optional[str] = None
filepath: Optional[str] = None
filesize: Optional[int] = None
fileurl: Optional[str] = None
timemodified: Optional[int] = None
mimetype: Optional[str] = None
isexternalfile: Optional[int] = None
repositorytype: Optional[str] = None


@dataclass
Expand Down Expand Up @@ -119,15 +119,15 @@ class BlogEntry:
subject: str
summary: str
summaryformat: int
content: Optional[str]
uniquehash: str
rating: int
format: int
attachment: str
publishstate: str
lastmodified: int
created: int
usermodified: Optional[int]
content: Optional[str] = None
usermodified: Optional[int] = None
summaryfiles: List[BlogSummaryFiles] = field(factory=list)
attachmentfiles: List[BlogAttachmentFile] = field(factory=list)
tags: List[BlogTag] = field(factory=list)
Expand Down
40 changes: 20 additions & 20 deletions moodle/core/calendar/course_event.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ class CourseEventCategory:
id: int
name: str
idnumber: str
description: Optional[str]
parent: int
coursecount: int
visible: int
timemodified: int
depth: int
nestedname: str
url: str
description: Optional[str] = None

def __str__(self) -> str:
return self.name
Expand Down Expand Up @@ -88,13 +88,13 @@ class CourseEventCourse:
fullnamedisplay: str
viewurl: str
courseimage: str
progress: Optional[int]
hasprogress: int
isfavourite: int
hidden: int
timeaccess: Optional[int]
showshortname: int
coursecategory: str
progress: Optional[int] = None
timeaccess: Optional[int] = None

def __str__(self) -> str:
return self.fullname
Expand All @@ -110,8 +110,8 @@ class CourseEventSubscription:
"""

displayeventsource: int
subscriptionname: Optional[str]
subscriptionurl: Optional[str]
subscriptionname: Optional[str] = None
subscriptionurl: Optional[str] = None

def __str__(self) -> str:
return self.subscriptionname or repr(self)
Expand Down Expand Up @@ -189,16 +189,7 @@ class CourseEvent:

id: int
name: str
description: Optional[str]
descriptionformat: int
location: Optional[str]
categoryid: Optional[int]
groupid: Optional[int]
userid: Optional[int]
repeatid: Optional[int]
eventcount: Optional[int]
modulename: Optional[str]
instance: Optional[int]
eventtype: str
timestart: int
timeduration: int
Expand All @@ -218,18 +209,27 @@ class CourseEvent:
isactionevent: int
iscourseevent: int
iscategoryevent: int
groupname: Optional[str]
normalisedeventtype: str
normalisedeventtypetext: str
url: str
action: Optional[CourseEventAction]
islastday: int
popupname: str
mindaytimestamp: Optional[int]
mindayerror: Optional[str]
maxdaytimestamp: Optional[int]
maxdayerror: Optional[str]
draggable: int
description: Optional[str] = None
location: Optional[str] = None
categoryid: Optional[int] = None
groupid: Optional[int] = None
userid: Optional[int] = None
repeatid: Optional[int] = None
eventcount: Optional[int] = None
modulename: Optional[str] = None
instance: Optional[int] = None
groupname: Optional[str] = None
action: Optional[CourseEventAction] = None
mindaytimestamp: Optional[int] = None
mindayerror: Optional[str] = None
maxdaytimestamp: Optional[int] = None
maxdayerror: Optional[str] = None

def __str__(self) -> str:
return self.name
Expand Down
2 changes: 1 addition & 1 deletion moodle/core/calendar/day_view.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ class DayView:
defaulteventcontext: int # defaulteventcontext
filter_selector: str # filter_selector
courseid: int # courseid
categoryid: Optional[int] # categoryid
neweventtimestamp: int # neweventtimestamp
date: DateView
periodname: str # periodname
Expand All @@ -37,3 +36,4 @@ class DayView:
nextperiod: Period
larrow: str # larrow
rarrow: str # rarrow
categoryid: Optional[int] = None # categoryid
Loading

0 comments on commit 1c7a995

Please sign in to comment.