Differential D7947 Diff 25818 tests/python/modules/test_object_generator.py

Changeset View

Standalone View

tests/python/modules/test_object_generator.py

This file was added.

				# ##### BEGIN GPL LICENSE BLOCK #####
				#
				# This program 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 2
				# of the License, or (at your option) any later version.
				#
				# This program 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 this program; if not, write to the Free Software Foundation,
				# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
				#
				# ##### END GPL LICENSE BLOCK #####

				# <pep8 compliant>
				zazizizouUnsubmitted Done Inline Actions This is redundant. You already have max value so just check if max is larger than the allowed maximum. You can do the same for negative values with min(..) zazizizou: This is redundant. You already have max value so just check if max is larger than the allowed…

				"""blender -b --python tests/python/modules/test_object_generator.py -- /path/to/blend/file/new_or_existing.blend"""
				import bpy
				zazizizouUnsubmitted Done Inline Actions the function is called do_selection but it also assigns vertex group? You should avoid this for two reasons: Name of function should be accurate A function should do 1 thing and 1 thing only, otherwise you confuse people using your function with unwanted side effects. zazizizou: the function is called do_selection but it also assigns vertex group? You should avoid this for…
				import os
				import sys
				import random
				from pathlib import Path

				offset_x = 5
				fail = 0


				def vertex_selection(object, vert_set: set, randomize: bool):
				zazizizouUnsubmitted Not Done Inline Actions You were right I think, `object` is a keyword in Python and it's probably best to choose something else. zazizizou: You were right I think, `object` is a keyword in Python and it's probably best to choose…
				"""
				zazizizouUnsubmitted Done Inline Actions It looks like you are passing an object and not a mesh, so argument name seems wrong... zazizizou: It looks like you are passing an object and not a mesh, so argument name seems wrong...
				Selecting vertices which will be later assigned to vertex groups
				:param: object: the selected object for vertex group
				:param: object: vert_set: set of indices e.g.{0,2,3)
				zazizizouUnsubmitted Done Inline Actions what if the object does not exist? zazizizou: what if the object does not exist?
				:parm: randomize: bool: select vertices randomly"""
				bpy.ops.object.mode_set(mode='EDIT')
				zazizizouUnsubmitted Done Inline Actions Use `True`/`False` instead zazizizou: Use `True`/`False` instead
				bpy.ops.mesh.select_all(action='DESELECT')
				bpy.ops.object.mode_set(mode='OBJECT')

				zazizizouUnsubmitted Done Inline Actions You should validate function input before doing anything, otherwise the function exists with an exception with the job half way done. You also probably don't need an extra function to validate input. Just write the validation code at the beginning of this function zazizizou: You should validate function input before doing anything, otherwise the function exists with an…
				if not randomize:
				for index in vert_set:
				object.data.vertices[index].select = True

				else:
				max_vert = len(object.data.vertices)
				random_size = random.randint(1, max_vert)
				print(random_size)
				for index in range(random_size):
				random_index = random.randint(0, random_size)
				print(random_index)
				object.data.vertices[random_index].select = True


				def create_vertex_group(obj_name, vg_name, vg_vert_set, randomize):
				"""
				Creates a vertex group. Raises Exception for invalid index
				:param obj_name : blend object: - the object for vertex group
				:param vg_name : str - vertex group name
				:param vg_vert_set : set - set of vertices assgined to the vertex group
				:param randomize : bool - select random vertices"""
				# Validating user input
				zazizizouUnsubmitted Done Inline Actions Not sure why you need a function here, you are wrapping only 1 line? zazizizou: Not sure why you need a function here, you are wrapping only 1 line?
				# -checking for whether the object exists
				# -index value is within the right range
				if not randomize and len(vg_vert_set) == 0:
				global fail
				fail = 1
				raise Exception('Set is empty!')
				if obj_name not in bpy.data.objects.keys():
				fail = 1
				raise Exception('Object {} not Found!'.format(obj_name))
				object = bpy.data.objects[obj_name]
				bpy.ops.object.select_all(action='DESELECT')
				object.select_set(True)
				bpy.context.view_layer.objects.active = object

				max_vert = len(object.data.vertices)
				for i in vg_vert_set:
				if not isinstance(i, int) or i < 0 or i > max_vert - 1:
				zazizizouUnsubmitted Done Inline Actions You don't have to duplicate this code for every obj_type, just write it once after all the if statments zazizizou: You don't have to duplicate this code for every obj_type, just write it once after all the if…
				fail = 1
				raise Exception("Please enter a valid index(integer).")

				object.vertex_groups.new(name=vg_name)
				vertex_selection(object, vg_vert_set, randomize)

				bpy.ops.object.mode_set(mode='EDIT')
				bpy.ops.object.vertex_group_assign()
				bpy.ops.object.mode_set(mode='OBJECT')
				print("'{}' vertex group is created.".format(vg_name))


				def get_last_location():
				"""To find the location of last created object."""
				farthest = 0
				all_y_locs = []
				for obj in bpy.data.objects:
				all_y_locs.append(obj.location.y)

				for y in all_y_locs:
				if y > farthest:
				farthest = y

				return farthest


				def create_test_objects(obj_dict):
				"""
				Creates test and expected objects
				:param obj_dict: dict (key:value) - dictionary contains test object names and types, e.g. {'myTestCube':'Cube'}
				"""
				offset_y = get_last_location() + 5
				test_obj_list = []

				for obj_name, obj_type in obj_dict.items():

				test_obj_name = "testObj" + obj_name

				if test_obj_name not in bpy.data.objects.keys():
				if obj_type == "Circle":
				bpy.ops.mesh.primitive_circle_add(location=(0, offset_y, 0))

				elif obj_type == "Cube":
				bpy.ops.mesh.primitive_cube_add(location=(0, offset_y, 0))

				elif obj_type == "Plane":
				bpy.ops.mesh.primitive_plane_add(location=(0, offset_y, 0))

				elif obj_type == "Sphere":
				bpy.ops.mesh.primitive_uv_sphere_add(location=(0, offset_y, 0))

				elif obj_type == "Cone":
				bpy.ops.mesh.primitive_cone_add(location=(0, offset_y, 0))

				elif obj_type == "Cylinder":
				bpy.ops.mesh.primitive_cylinder_add(location=(0, offset_y, 0))

				elif obj_type == "Icosphere":
				bpy.ops.mesh.primitive_ico_sphere_add(location=(0, offset_y, 0))

				zazizizouUnsubmitted Done Inline Actions This is one more reason why a class would be better here, where you save all internal states within the class instead of having to declare global variables. Also, flag is not descriptive enough. Something like `success` is more commonly used zazizizou: This is one more reason why a class would be better here, where you save all internal states…
				elif obj_type == "Torus":
				bpy.ops.mesh.primitive_torus_add(location=(0, offset_y, 0))

				elif obj_type == "Monkey":
				bpy.ops.mesh.primitive_monkey_add(location=(0, offset_y, 0))

				elif obj_type == "Grid":
				bpy.ops.mesh.primitive_grid_add(location=(0, offset_y, 0))
				zazizizouUnsubmitted Done Inline Actions This has to be removed. The script must have a well defined list of arguments. The user as well as the underlying function can 'agree' on what the arguments mean beforehand. Ideally you should print a help message about how the script is supposed to be used, what it does and so on... zazizizou: This has to be removed. The script must have a well defined list of arguments. The user as well…
				else:
				global fail
				fail = 1
				raise Exception("'{}' object type not yet supported.".format(obj_type))

				test_obj_list.append(test_obj_name)
				bpy.context.active_object.name = test_obj_name
				bpy.ops.object.duplicate_move(TRANSFORM_OT_translate={"value": (offset_x, 0, 0)})
				bpy.context.active_object.name = "expObj" + obj_name

				zazizizouUnsubmitted Done Inline Actions The file will get created even when there are errors later on. Is this intentional? It's probably best to either create a file that has been generated correctly or don't create anything at all, right? zazizizou: The file will get created even when there are errors later on. Is this intentional? It's…
				offset_y += 5
				else:
				print("Object already present.")
				zazizizouUnsubmitted Not Done Inline Actions is conversion to str really necessary? I thought it could work without it.. zazizizou: is conversion to str really necessary? I thought it could work without it..
				calraAuthorUnsubmitted Done Inline Actions yes calra: yes

				if not fail:
				print("{} were successfully created!".format(test_obj_list))


				argv = sys.argv
				argv = argv[argv.index("--") + 1:]

				# Converting the path to be platform independent and then into string
				actual_path = Path(argv[0])
				calraAuthorUnsubmitted Done Inline Actions This one's extra, and will be removed in the next commit. calra: This one's extra, and will be removed in the next commit.
				path_to_file = str(actual_path)
				zazizizouUnsubmitted Done Inline Actions Does this really work? `flag` is set inside the function `create_test_objects()` but it only gets checked before that function is called... zazizizou: Does this really work? `flag` is set inside the function `create_test_objects()` but it only…
				new_file = 0
				print(path_to_file)
				if os.path.exists(path_to_file):

				bpy.ops.wm.open_mainfile(filepath=path_to_file)


				else:
				# Looking at the global fail variable
				new_file = 1
				bpy.ops.wm.save_as_mainfile(filepath=path_to_file)
				# Cleaning up a new blend file
				bpy.data.objects['Light'].hide_set(True)
				bpy.data.objects['Camera'].hide_set(True)

				# Function calls
				try:
				create_test_objects({'Cube1': 'Cube', 'Cy455': "Cylinder"})
				create_vertex_group('expObjCube', "vg_solidify", {0, 1, 2, 3}, False)
				finally:
				if fail and new_file:
				os.remove(path_to_file)
				print("There was an error! The file is not created!")

				if not fail:
				bpy.ops.wm.save_mainfile(filepath=path_to_file)