Delete a bunch of redundant functions

Author: christopher-dG

client_connection.go

@@ -20,10 +20,10 @@ func (c *Client) Connect() error {
 
 	// We can't use SendRequest yet because we haven't started polling.
 
-	reqGAR := GetAuthRequiredRequest{
+	reqGAR := GetAuthRequiredRequest{_request{
 		ID_:   getMessageID(),
 		Type_: "GetAuthRequired",
-	}
+	}}
 	if err = c.conn.WriteJSON(reqGAR); err != nil {
 		return errors.Wrap(err, "write Authenticate")
 	}

codegen/protocol.py

@@ -10,9 +10,9 @@
 
 doc = "https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md"
 
-disclaimer = """\
+disclaimer = """
 // This file is automatically generated.
-// https://github.com/christopher-dG/go-obs-websocket/blob/master/codegen/protocol.py\
+// https://github.com/christopher-dG/go-obs-websocket/blob/master/codegen/protocol.py
 """
 
 # TODO: Test the less clear ones.
@@ -44,10 +44,16 @@ def process_json(d: Dict):
 def gen_category(prefix: str, category: str, data: Dict):
     """Generate all events or requests in one category."""
     func = gen_event if prefix == "events" else gen_request
-    content = "\n\n".join(func(event) for event in data)
+    content = "\n".join(
+        filter(
+            lambda s: not s.isspace(),
+            "\n".join(func(thing) for thing in data).split("\n"),
+        )
+    )
+
     with open(f"{prefix}_{category}.go".replace(" ", "_"), "w") as f:
         f.write(
-            f"""\
+            f"""
         package {package}
 
         {disclaimer}
@@ -65,15 +71,14 @@ def gen_events(events: Dict):
 
 def gen_event(data: Dict) -> str:
     """Write Go code with a type definition and interface functions."""
-    if data.get("returns"):
-        struct = f"""\
-        type {data["name"]}Event struct {{
-            {go_struct_variables(go_variables(data["returns"]))}
-            _event `json:",squash"`
-        }}\
-        """
-    else:
-        struct = f"type {data['name']}Event _event"
+    struct = f"""
+    type {data["name"]}Event struct {{
+        {go_struct_variables(go_variables(data.get("returns", [])))}
+        _event `json:",squash"`
+    }}
+    """
+    # else:
+    #     struct = f"type {data['name']}Event _event"
 
     description = newlinify(f"{data['name']}Event : {data['description']}")
     if not description.endswith("."):
@@ -83,19 +88,10 @@ def gen_event(data: Dict) -> str:
             f"\n// Since obs-websocket version: {data['since'].capitalize()}."
         )
 
-    return f"""\
+    return f"""
     {description}
     // {doc}#{data["heading"]["text"].lower()}
     {struct}
-
-    // Type returns the event's update type.
-    func (e {data["name"]}Event) Type() string {{ return e.Type_ }}
-
-    // StreamTimecode returns the event's stream timecode.
-    func (e {data["name"]}Event) StreamTimecode() string {{ return e.StreamTimecode_ }}
-
-    // RecTimecode returns the event's recording timecode.
-    func (e {data["name"]}Event) RecTimecode() string {{ return e.RecTimecode_ }}
     """
 
 
@@ -108,14 +104,14 @@ def gen_requests(requests: Dict):
 def gen_request(data: Dict) -> str:
     """Write Go code with type definitions and interface functions."""
     if data.get("params"):
-        struct = f"""\
+        struct = f"""
         type {data["name"]}Request struct {{
             {go_struct_variables(go_variables(data["params"]))}
             _request `json:",squash"`
         }}
         """
     else:
-        struct = f"type {data['name']}Request _request"
+        struct = f"type {data['name']}Request struct {{ _request }}"
 
     description = newlinify(f"{data['name']}Request : {data['description']}")
     if description and not description.endswith("."):
@@ -125,19 +121,13 @@ def gen_request(data: Dict) -> str:
             f"\n// Since obs-websocket version: {data['since'].capitalize()}."
         )
 
-    request = f"""\
+    request = f"""
     {description}
     // {doc}#{data["heading"]["text"].lower()}
     {struct}
 
     {gen_request_new(data)}
 
-    // ID returns the request's message ID.
-    func (r {data["name"]}Request) ID() string {{ return r.ID_ }}
-
-    // Type returns the request's message type.
-    func (r {data["name"]}Request) Type() string {{ return r.Type_ }}
-
     // Send sends the request and returns a channel to which the response will be sent.
     func (r {data["name"]}Request) Send(c Client) (chan {data["name"]}Response, error) {{
         generic, err := c.SendRequest(r)
@@ -151,49 +141,47 @@ def gen_request(data: Dict) -> str:
     """
 
     if data.get("returns"):
-        struct = f"""\
+        struct = f"""
         type {data["name"]}Response struct {{
             {go_struct_variables(go_variables(data["returns"]))}
             _response `json:",squash"`
         }}
         """
     else:
-        struct = f"type {data['name']}Response _response"
+        struct = (
+            f"""type {data["name"]}Response struct {{ _response `json:",squash"`}}"""
+        )
 
     description = f"// {data['name']}Response : Response for {data['name']}Request."
     if data.get("since"):
         description += (
             f"\n// Since obs-websocket version: {data['since'].capitalize()}."
         )
 
-    response = f"""\
+    response = f"""
     {description}
     // {doc}#{data["heading"]["text"].lower()}
     {struct}
-
-    // ID returns the response's message ID.
-    func (r {data["name"]}Response) ID() string {{ return r.ID_ }}
-
-    // Status returns the response's status.
-    func (r {data["name"]}Response) Status() string {{ return r.Status_ }}
-
-    // Error returns the response's error.
-    func (r {data["name"]}Response) Error() string {{ return r.Error_ }}
     """
 
     return f"{request}\n\n{response}"
 
 
 def gen_request_new(request: Dict):
     """Generate Go code with a New___Request function for a request type."""
-    base = f"""\
+    base = f"""
     // New{request["name"]}Request returns a new {request["name"]}Request.
     func New{request["name"]}Request(\
     """
     variables = go_variables(request.get("params", []), export=False)
     if not variables:
-        sig = f"{base}) {request['name']}Request {{"
-        constructor_args = f'{{ID_: getMessageID(), Type_: "{request["name"]}"}}'
+        sig = f"{base}) {request['name']}Request"
+        constructor_args = f"""\
+        {{_request{{
+            ID_: getMessageID(),
+            Type_: "{request["name"]}",
+        }}}}
+        """
     else:
         args = "\n".join(
             f"{'_type' if var['name'] == 'type' else var['name']} {var['type']},"
@@ -214,18 +202,14 @@ def gen_request_new(request: Dict):
         """
         )
         if len(variables) == 1:
-            sig = f"{base}{args}) {request['name']}Request {{"
+            sig = f"{base}{args}) {request['name']}Request"
         else:
-            sig = f"""\
+            sig = f"""
             {base}
                 {args}
-            ) {request["name"]}Request {{\
+            ) {request["name"]}Request\
             """
-    return f"""\
-    {sig}
-        return {request["name"]}Request{constructor_args}
-    }}\
-    """
+    return f"{sig} {{ return {request['name']}Request{constructor_args} }}"
 
 
 def gen_typeswitches(data: Dict):
@@ -270,7 +254,7 @@ def gen_typeswitches(data: Dict):
 
     with open("typeswitches.go", "w") as f:
         f.write(
-            f"""\
+            f"""
         package {package}
 
         {disclaimer}

events.go

@@ -14,8 +14,11 @@ type _event struct {
 	RecTimecode_    string `json:"rec-timecode"`
 }
 
+// Type returns the event's update type.
 func (e _event) Type() string { return e.Type_ }
 
+// StreamTimeode returns the event's stream timecode.
 func (e _event) StreamTimecode() string { return e.StreamTimecode_ }
 
+// RecTimecode returns the event's recording timecode.
 func (e _event) RecTimecode() string { return e.RecTimecode_ }

events_general.go

@@ -41,12 +41,3 @@ type HeartbeatEvent struct {
 	TotalRecordFrames int `json:"total-record-frames"`
 	_event            `json:",squash"`
 }
-
-// Type returns the event's update type.
-func (e HeartbeatEvent) Type() string { return e.Type_ }
-
-// StreamTimecode returns the event's stream timecode.
-func (e HeartbeatEvent) StreamTimecode() string { return e.StreamTimecode_ }
-
-// RecTimecode returns the event's recording timecode.
-func (e HeartbeatEvent) RecTimecode() string { return e.RecTimecode_ }

events_other.go

@@ -6,13 +6,6 @@ package obsws
 // ExitingEvent : OBS is exiting.
 // Since obs-websocket version: 0.3.
 // https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md#exiting
-type ExitingEvent _event
-
-// Type returns the event's update type.
-func (e ExitingEvent) Type() string { return e.Type_ }
-
-// StreamTimecode returns the event's stream timecode.
-func (e ExitingEvent) StreamTimecode() string { return e.StreamTimecode_ }
-
-// RecTimecode returns the event's recording timecode.
-func (e ExitingEvent) RecTimecode() string { return e.RecTimecode_ }
+type ExitingEvent struct {
+	_event `json:",squash"`
+}

events_profiles.go

@@ -6,27 +6,13 @@ package obsws
 // ProfileChangedEvent : Triggered when switching to another profile or when renaming the current profile.
 // Since obs-websocket version: 4.0.0.
 // https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md#profilechanged
-type ProfileChangedEvent _event
-
-// Type returns the event's update type.
-func (e ProfileChangedEvent) Type() string { return e.Type_ }
-
-// StreamTimecode returns the event's stream timecode.
-func (e ProfileChangedEvent) StreamTimecode() string { return e.StreamTimecode_ }
-
-// RecTimecode returns the event's recording timecode.
-func (e ProfileChangedEvent) RecTimecode() string { return e.RecTimecode_ }
+type ProfileChangedEvent struct {
+	_event `json:",squash"`
+}
 
 // ProfileListChangedEvent : Triggered when a profile is created, added, renamed, or removed.
 // Since obs-websocket version: 4.0.0.
 // https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md#profilelistchanged
-type ProfileListChangedEvent _event
-
-// Type returns the event's update type.
-func (e ProfileListChangedEvent) Type() string { return e.Type_ }
-
-// StreamTimecode returns the event's stream timecode.
-func (e ProfileListChangedEvent) StreamTimecode() string { return e.StreamTimecode_ }
-
-// RecTimecode returns the event's recording timecode.
-func (e ProfileListChangedEvent) RecTimecode() string { return e.RecTimecode_ }
+type ProfileListChangedEvent struct {
+	_event `json:",squash"`
+}

events_recording.go

@@ -6,55 +6,27 @@ package obsws
 // RecordingStartingEvent : A request to start recording has been issued.
 // Since obs-websocket version: 0.3.
 // https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md#recordingstarting
-type RecordingStartingEvent _event
-
-// Type returns the event's update type.
-func (e RecordingStartingEvent) Type() string { return e.Type_ }
-
-// StreamTimecode returns the event's stream timecode.
-func (e RecordingStartingEvent) StreamTimecode() string { return e.StreamTimecode_ }
-
-// RecTimecode returns the event's recording timecode.
-func (e RecordingStartingEvent) RecTimecode() string { return e.RecTimecode_ }
+type RecordingStartingEvent struct {
+	_event `json:",squash"`
+}
 
 // RecordingStartedEvent : Recording started successfully.
 // Since obs-websocket version: 0.3.
 // https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md#recordingstarted
-type RecordingStartedEvent _event
-
-// Type returns the event's update type.
-func (e RecordingStartedEvent) Type() string { return e.Type_ }
-
-// StreamTimecode returns the event's stream timecode.
-func (e RecordingStartedEvent) StreamTimecode() string { return e.StreamTimecode_ }
-
-// RecTimecode returns the event's recording timecode.
-func (e RecordingStartedEvent) RecTimecode() string { return e.RecTimecode_ }
+type RecordingStartedEvent struct {
+	_event `json:",squash"`
+}
 
 // RecordingStoppingEvent : A request to stop recording has been issued.
 // Since obs-websocket version: 0.3.
 // https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md#recordingstopping
-type RecordingStoppingEvent _event
-
-// Type returns the event's update type.
-func (e RecordingStoppingEvent) Type() string { return e.Type_ }
-
-// StreamTimecode returns the event's stream timecode.
-func (e RecordingStoppingEvent) StreamTimecode() string { return e.StreamTimecode_ }
-
-// RecTimecode returns the event's recording timecode.
-func (e RecordingStoppingEvent) RecTimecode() string { return e.RecTimecode_ }
+type RecordingStoppingEvent struct {
+	_event `json:",squash"`
+}
 
 // RecordingStoppedEvent : Recording stopped successfully.
 // Since obs-websocket version: 0.3.
 // https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md#recordingstopped
-type RecordingStoppedEvent _event
-
-// Type returns the event's update type.
-func (e RecordingStoppedEvent) Type() string { return e.Type_ }
-
-// StreamTimecode returns the event's stream timecode.
-func (e RecordingStoppedEvent) StreamTimecode() string { return e.StreamTimecode_ }
-
-// RecTimecode returns the event's recording timecode.
-func (e RecordingStoppedEvent) RecTimecode() string { return e.RecTimecode_ }
+type RecordingStoppedEvent struct {
+	_event `json:",squash"`
+}