Inventree-Python search for part's PK based on part.IPN

[bobb-uk]

Hi all,

Is there a simple method to obtain the primary key (pk) of a part based on the part's IPN.
So I have "830-00017" as the part.IPN and "My fancy controller" as the part.name and want returned the pk from the table, to be used in the next Python call; Eg a delete, or make-active or a BOM link.

Currently I am using a DICT based on all parts returned from my database.
This is OK for me, for now, but I'm sure there is a more succinct method. I simply cannot see it at the moment.

For those who are interested, here is my code:

import uno

from inventree.api import InvenTreeAPI
from inventree.part import PartCategory, Part


def items_into_dict():
	#SERVER_ADDRESS = 'http://inventree/'
	SERVER_ADDRESS = 'http://172.17.16.84'
	USER='testuser'
	PASS='testpassword'

	doc = XSCRIPTCONTEXT.getDocument()
	sheet = doc.getCurrentController().getActiveSheet()

	api = InvenTreeAPI(SERVER_ADDRESS, username=USER, password=PASS)
	categories = PartCategory.list(api, parent='')
	category_size = len(categories)

	COMPANY_items = {}  #Dict to hold items IPNs as keys and Inventree pk as values

	for n in range(0, category_size):

		meta_u = categories[n].metadata_url
		pk = categories[n].getPkField()
		pkv = categories[n].getPkValue()
		mt = categories[n].getModelType()
		if (mt == 'partcategory'):
			cc = categories[n].getChildCategories()
			if (len(cc) >= 1):
				i2=len(cc)
				for i in range(0, i2):
					cc_pkv = cc[i].getPkValue()
					cc_pkv_name = PartCategory(api, cc_pkv).name
					if (1==1):
						cp=cc[i].getParts()
						j2 = len(cp)
						for j in range(0, j2):
							cp_pkv = cp[j].getPkValue()
							cp_pkv_name = cp[j].name
							cp_pkv_IPN = cp[j].IPN

							COMPANY_items[cp_pkv_IPN]=cp_pkv

	col = 0
	row = 0

	for dict_IPN, dict_pk in COMPANY_items.items():
		cell = sheet.getCellByPosition(col,row)
		cell.setString(dict_IPN)
		cell = sheet.getCellByPosition(col+1,row)
		cell.setString(dict_pk)
		row+=1
	return

[bobb-uk]

I found this in someone else's code and will give it a tryout.

from part.models import Part

bla
bla
bla

 # Don't create IPNs for parts with IPNs
        part = Part.objects.get(id=id)
        if part.IPN:
            return

[Yigtwxx]

Yes — Part.list() passes any keyword straight through as an API query parameter (in inventree/base.py, list() ends up doing api.get(url=cls.URL, params=kwargs)), and the part endpoint supports an IPN filter, so you don't need the dictionary at all:

from inventree.part import Part

parts = Part.list(api, IPN='830-00017')
pk = parts[0].pk if parts else None

Three things worth knowing before relying on it. I checked these against demo.inventree.org (API 530):

query	result
?IPN=widget.blue	1 part
?IPN=WIDGET.BLUE	same part — the value match is case-insensitive
?ipn=widget.blue	446 parts (the entire table)
?IPN=ENCAB	6 parts
?IPN_regex=^widget	8 parts
?IPN_icontains=widget	446 parts

• The parameter name is case-sensitive. ipn= isn't recognised, and an unrecognised filter is silently dropped rather than raising, so you get everything back instead of an error. Easy one to lose an hour to.
• IPN is not unique. ENCAB returns 6 parts in the demo data, so treat the result as a list and decide explicitly what >1 means for you rather than taking [0].
• IPN_regex is there if you want prefix or partial matching. IPN_icontains is not, and gets dropped the same silent way.

One note on the snippet you found in your follow-up post: from part.models import Part is server-side Django code, so it only runs inside InvenTree itself (plugins, management commands, migrations). From an external script driving the REST API you want inventree.part.Part as above.