Merge pull request OpenShot#2994 from ferdnyc/blender-py-style

Blender Python scripts: Code formatting
angelvilaplana · Nov 17, 2019 · b380279 · b380279
2 parents 69632c1 + 0524a02
commit b380279
Show file tree

Hide file tree

Showing 20 changed files with 1,386 additions and 1,384 deletions.
diff --git a/src/blender/scripts/blinds.py b/src/blender/scripts/blinds.py
@@ -1,84 +1,85 @@
-#	OpenShot Video Editor is a program that creates, modifies, and edits video files.
+# OpenShot Video Editor is a program that creates, modifies, and edits video files.
 #   Copyright (C) 2009  Jonathan Thomas
 #
-#	This file is part of OpenShot Video Editor (http://launchpad.net/openshot/).
+# This file is part of OpenShot Video Editor (http://launchpad.net/openshot/).
 #
-#	OpenShot Video Editor is free software: you can redistribute it and/or modify
-#	it under the terms of the GNU General Public License as published by
-#	the Free Software Foundation, either version 3 of the License, or
-#	(at your option) any later version.
+# OpenShot Video Editor is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-#	OpenShot Video Editor is distributed in the hope that it will be useful,
-#	but WITHOUT ANY WARRANTY; without even the implied warranty of
-#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#	GNU General Public License for more details.
+# OpenShot Video Editor is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
-#	You should have received a copy of the GNU General Public License
-#	along with OpenShot Video Editor.  If not, see <http://www.gnu.org/licenses/>.
+# You should have received a copy of the GNU General Public License
+# along with OpenShot Video Editor.  If not, see <http://www.gnu.org/licenses/>.
 
 
 # Import Blender's python API.  This only works when the script is being
 # run from the context of Blender.  Blender contains it's own version of Python
 # with this library pre-installed.
 import bpy
 
-# Load a font
+
 def load_font(font_path):
-	""" Load a new TTF font into Blender, and return the font object """
-	# get the original list of fonts (before we add a new one)
-	original_fonts = bpy.data.fonts.keys()
-	
-	# load new font
-	bpy.ops.font.open(filepath=font_path)
-	
-	# get the new list of fonts (after we added a new one)
-	for font_name in bpy.data.fonts.keys():
-		if font_name not in original_fonts:
-			return bpy.data.fonts[font_name]
-		
-	# no new font was added
-	return None
+    """ Load a new TTF font into Blender, and return the font object """
+    # get the original list of fonts (before we add a new one)
+    original_fonts = bpy.data.fonts.keys()
+
+    # load new font
+    bpy.ops.font.open(filepath=font_path)
+
+    # get the new list of fonts (after we added a new one)
+    for font_name in bpy.data.fonts.keys():
+        if font_name not in original_fonts:
+            return bpy.data.fonts[font_name]
+
+    # no new font was added
+    return None
 
 # Debug Info:
 # ./blender -b test.blend -P demo.py
 # -b = background mode
 # -P = run a Python script within the context of the project file
 
+
 # Init all of the variables needed by this script.  Because Blender executes
 # this script, OpenShot will inject a dictionary of the required parameters
 # before this script is executed.
-params = {		
-			'title' : 'Oh Yeah! OpenShot!',
-			'extrude' : 0.1,
-			'bevel_depth' : 0.02,
-			'spacemode' : 'CENTER',
-			'text_size' : 1.5,
-			'width' : 1.0,
-			'fontname' : 'Bfont',
-			
-			'color' : [0.8,0.8,0.8],
-			'alpha' : 1.0,
-			
-			'output_path' : '/tmp/',
-			'fps' : 24,
-			'quality' : 90,
-			'file_format' : 'PNG',
-			'color_mode' : 'RGBA',
-			'horizon_color' : [0.57, 0.57, 0.57],
-			'resolution_x' : 1920,
-			'resolution_y' : 1080,
-			'resolution_percentage' : 100,
-			'start_frame' : 20,
-			'end_frame' : 25,
-			'animation' : True,
-		}
-
-#INJECT_PARAMS_HERE
+params = {
+    'title': 'Oh Yeah! OpenShot!',
+    'extrude': 0.1,
+    'bevel_depth': 0.02,
+    'spacemode': 'CENTER',
+    'text_size': 1.5,
+    'width': 1.0,
+    'fontname': 'Bfont',
+
+    'color': [0.8, 0.8, 0.8],
+    'alpha': 1.0,
+
+    'output_path': '/tmp/',
+    'fps': 24,
+    'quality': 90,
+    'file_format': 'PNG',
+    'color_mode': 'RGBA',
+    'horizon_color': [0.57, 0.57, 0.57],
+    'resolution_x': 1920,
+    'resolution_y': 1080,
+    'resolution_percentage': 100,
+    'start_frame': 20,
+    'end_frame': 25,
+    'animation': True,
+}
+
+# INJECT_PARAMS_HERE
 
 # The remainder of this script will modify the current Blender .blend project
 # file, and adjust the settings.  The .blend file is specified in the XML file
 # that defines this template in OpenShot.
-#----------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
 
 # Modify Text / Curve settings
 #print (bpy.data.curves.keys())
@@ -93,12 +94,12 @@ def load_font(font_path):
 # Get font object
 font = None
 if params["fontname"] != "Bfont":
-	# Add font so it's available to Blender
-	font = load_font(params["fontname"])
+    # Add font so it's available to Blender
+    font = load_font(params["fontname"])
 else:
-	# Get default font
-	font = bpy.data.fonts["Bfont"]
-	
+    # Get default font
+    font = bpy.data.fonts["Bfont"]
+
 text_object.font = font
 
 text_object = bpy.data.curves["Subtitle"]
@@ -134,15 +135,14 @@ def load_font(font_path):
 bpy.context.scene.frame_end = params["end_frame"]
 
 # Animation Speed (use Blender's time remapping to slow or speed up animation)
-animation_speed = int(params["animation_speed"])	# time remapping multiplier
-new_length = int(params["end_frame"]) * animation_speed	# new length (in frames)
+animation_speed = int(params["animation_speed"])  # time remapping multiplier
+new_length = int(params["end_frame"]) * animation_speed  # new length (in frames)
 bpy.context.scene.frame_end = new_length
 bpy.context.scene.render.frame_map_old = 1
 bpy.context.scene.render.frame_map_new = animation_speed
 if params["start_frame"] == params["end_frame"]:
-	bpy.context.scene.frame_start = params["end_frame"]
-	bpy.context.scene.frame_end = params["end_frame"]
+    bpy.context.scene.frame_start = params["end_frame"]
+    bpy.context.scene.frame_end = params["end_frame"]
 
 # Render the current animation to the params["output_path"] folder
 bpy.ops.render.render(animation=params["animation"])
-
diff --git a/src/blender/scripts/blur.py b/src/blender/scripts/blur.py
@@ -1,86 +1,87 @@
-#	OpenShot Video Editor is a program that creates, modifies, and edits video files.
+# OpenShot Video Editor is a program that creates, modifies, and edits video files.
 #   Copyright (C) 2009  Jonathan Thomas
 #
-#	This file is part of OpenShot Video Editor (http://launchpad.net/openshot/).
+# This file is part of OpenShot Video Editor (http://launchpad.net/openshot/).
 #
-#	OpenShot Video Editor is free software: you can redistribute it and/or modify
-#	it under the terms of the GNU General Public License as published by
-#	the Free Software Foundation, either version 3 of the License, or
-#	(at your option) any later version.
+# OpenShot Video Editor is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-#	OpenShot Video Editor is distributed in the hope that it will be useful,
-#	but WITHOUT ANY WARRANTY; without even the implied warranty of
-#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#	GNU General Public License for more details.
+# OpenShot Video Editor is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
-#	You should have received a copy of the GNU General Public License
-#	along with OpenShot Video Editor.  If not, see <http://www.gnu.org/licenses/>.
+# You should have received a copy of the GNU General Public License
+# along with OpenShot Video Editor.  If not, see <http://www.gnu.org/licenses/>.
 
 
 # Import Blender's python API.  This only works when the script is being
 # run from the context of Blender.  Blender contains it's own version of Python
 # with this library pre-installed.
 import bpy
 
-# Load a font
+
 def load_font(font_path):
-	""" Load a new TTF font into Blender, and return the font object """
-	# get the original list of fonts (before we add a new one)
-	original_fonts = bpy.data.fonts.keys()
-	
-	# load new font
-	bpy.ops.font.open(filepath=font_path)
-	
-	# get the new list of fonts (after we added a new one)
-	for font_name in bpy.data.fonts.keys():
-		if font_name not in original_fonts:
-			return bpy.data.fonts[font_name]
-		
-	# no new font was added
-	return None
+    """ Load a new TTF font into Blender, and return the font object """
+    # get the original list of fonts (before we add a new one)
+    original_fonts = bpy.data.fonts.keys()
+
+    # load new font
+    bpy.ops.font.open(filepath=font_path)
+
+    # get the new list of fonts (after we added a new one)
+    for font_name in bpy.data.fonts.keys():
+        if font_name not in original_fonts:
+            return bpy.data.fonts[font_name]
+
+    # no new font was added
+    return None
 
 # Debug Info:
 # ./blender -b test.blend -P demo.py
 # -b = background mode
 # -P = run a Python script within the context of the project file
 
+
 # Init all of the variables needed by this script.  Because Blender executes
 # this script, OpenShot will inject a dictionary of the required parameters
 # before this script is executed.
-params = {		
-			'title' : 'Oh Yeah! OpenShot!',
-			'extrude' : 0.1,
-			'bevel_depth' : 0.02,
-			'spacemode' : 'CENTER',
-			'text_size' : 1.5,
-			'width' : 1.0,
-			'fontname' : 'Bfont',
-			
-			'color' : [0.8,0.8,0.8],
-			'alpha' : 1.0,
-			
-			'output_path' : '/tmp/',
-			'fps' : 24,
-			'quality' : 90,
-			'file_format' : 'PNG',
-			'color_mode' : 'RGBA',
-			'horizon_color' : [0.57, 0.57, 0.57],
-			'resolution_x' : 1920,
-			'resolution_y' : 1080,
-			'resolution_percentage' : 100,
-			'start_frame' : 20,
-			'end_frame' : 25,
-			'animation' : True,
-			'blur_amount_x': 75,
-			'blur_amount_y': 75,
-		}
-
-#INJECT_PARAMS_HERE
+params = {
+    'title': 'Oh Yeah! OpenShot!',
+    'extrude': 0.1,
+    'bevel_depth': 0.02,
+    'spacemode': 'CENTER',
+    'text_size': 1.5,
+    'width': 1.0,
+    'fontname': 'Bfont',
+
+    'color': [0.8, 0.8, 0.8],
+    'alpha': 1.0,
+
+    'output_path': '/tmp/',
+    'fps': 24,
+    'quality': 90,
+    'file_format': 'PNG',
+    'color_mode': 'RGBA',
+    'horizon_color': [0.57, 0.57, 0.57],
+    'resolution_x': 1920,
+    'resolution_y': 1080,
+    'resolution_percentage': 100,
+    'start_frame': 20,
+    'end_frame': 25,
+    'animation': True,
+    'blur_amount_x': 75,
+    'blur_amount_y': 75,
+}
+
+# INJECT_PARAMS_HERE
 
 # The remainder of this script will modify the current Blender .blend project
 # file, and adjust the settings.  The .blend file is specified in the XML file
 # that defines this template in OpenShot.
-#----------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
 
 # Modify Text / Curve settings
 #print (bpy.data.curves.keys())
@@ -95,11 +96,11 @@ def load_font(font_path):
 # Get font object
 font = None
 if params["fontname"] != "Bfont":
-	# Add font so it's available to Blender
-	font = load_font(params["fontname"])
+    # Add font so it's available to Blender
+    font = load_font(params["fontname"])
 else:
-	# Get default font
-	font = bpy.data.fonts["Bfont"]
+    # Get default font
+    font = bpy.data.fonts["Bfont"]
 
 text_object.font = font
 
@@ -131,15 +132,14 @@ def load_font(font_path):
 bpy.context.scene.frame_end = params["end_frame"]
 
 # Animation Speed (use Blender's time remapping to slow or speed up animation)
-animation_speed = int(params["animation_speed"])	# time remapping multiplier
-new_length = int(params["end_frame"]) * animation_speed	# new length (in frames)
+animation_speed = int(params["animation_speed"])  # time remapping multiplier
+new_length = int(params["end_frame"]) * animation_speed  # new length (in frames)
 bpy.context.scene.frame_end = new_length
 bpy.context.scene.render.frame_map_old = 1
 bpy.context.scene.render.frame_map_new = animation_speed
 if params["start_frame"] == params["end_frame"]:
-	bpy.context.scene.frame_start = params["end_frame"]
-	bpy.context.scene.frame_end = params["end_frame"]
+    bpy.context.scene.frame_start = params["end_frame"]
+    bpy.context.scene.frame_end = params["end_frame"]
 
 # Render the current animation to the params["output_path"] folder
 bpy.ops.render.render(animation=params["animation"])
-