TipsAndTricks/Tinfoil - Revision history

PaulEggleton: Add 2.4+ material for enumerating recipes

2018-03-14T00:57:23Z

Add 2.4+ material for enumerating recipes

@@ Line 69: / Line 69: @@
 == Enumerating available recipes ==
-Iterating over available recipes in the system is relatively straightforward:
+Iterating over available recipes in the system is relatively straightforward.
 <pre>

PaulEggleton: /* Other useful functions */

2017-06-01T03:14:58Z

Other useful functions

← Older revision		Revision as of 03:14, 1 June 2017
Line 89:		Line 89:
	== Other useful functions ==		== Other useful functions ==

	Tinfoil also gives you access to quite a bit of BitBake and OE utility code - in particular have a look in <code>bitbake/lib/bb/utils.py</code>, <code>meta/lib/oe/utils.py</code>, and <code>meta/lib/oe/recipeutils.py</code> ~~files~~ as they all contain useful functions that will help you perform various tasks that might be interesting from a script that uses tinfoil.		Tinfoil also gives you access to quite a bit of BitBake and OE utility code - in particular have a look in <code>bitbake/lib/bb/utils.py</code>, <code>meta/lib/oe/utils.py</code>, and <code>meta/lib/oe/recipeutils.py</code> as they all contain useful functions that will help you perform various tasks that might be interesting from a script that uses tinfoil.

PaulEggleton at 03:14, 1 June 2017

2017-06-01T03:14:34Z

← Older revision		Revision as of 03:14, 1 June 2017
Line 89:		Line 89:
	== Other useful functions ==		== Other useful functions ==

	Tinfoil also gives you access to quite a bit of BitBake and OE utility code - in particular have a look in bitbake/lib/bb/utils.py, meta/lib/oe/utils.py, and meta/lib/oe/recipeutils.py files as they all contain useful functions that will help you perform various tasks that might be interesting from a script that uses tinfoil.		Tinfoil also gives you access to quite a bit of BitBake and OE utility code - in particular have a look in <code>bitbake/lib/bb/utils.py</code>, <code>meta/lib/oe/utils.py</code>, and <code>meta/lib/oe/recipeutils.py</code> files as they all contain useful functions that will help you perform various tasks that might be interesting from a script that uses tinfoil.

PaulEggleton at 03:13, 1 June 2017

2017-06-01T03:13:09Z

← Older revision		Revision as of 03:13, 1 June 2017
Line 8:		Line 8:
	The tinfoil API, which was introduced to BitBake a number of years ago and underwent a major rework in the 2.3 (pyro) release, provides a way for you to write python scripts to interact with the metadata and call into BitBake/OpenEmbedded code. It's intended to be an easier-to-use wrapper around BitBake's internal code, hence the name. Some of the scripts that come with BitBake / OpenEmbedded make heavy use of it - <code>bitbake-layers</code>, <code>devtool</code>, <code>recipetool</code> and <code>oe-pkgdata-util</code> are examples.		The tinfoil API, which was introduced to BitBake a number of years ago and underwent a major rework in the 2.3 (pyro) release, provides a way for you to write python scripts to interact with the metadata and call into BitBake/OpenEmbedded code. It's intended to be an easier-to-use wrapper around BitBake's internal code, hence the name. Some of the scripts that come with BitBake / OpenEmbedded make heavy use of it - <code>bitbake-layers</code>, <code>devtool</code>, <code>recipetool</code> and <code>oe-pkgdata-util</code> are examples.

	== ~~Getting a variable value~~ ==		== Preamble - loading tinfoil ==

	~~Let~~'s ~~take~~ a ~~look at a simple example which reads a configuration-level variable value - <code>TMPDIR</code>~~ to be ~~specific~~. This script ~~needs to~~ be placed in the <code>scripts</code> subdirectory ~~to work as-is~~, although you can modify the import code to make it work from anywhere:		There's a bit of mostly boilerplate that needs to be at the start of any script using tinfoil. This is written assuming the script will be placed in the <code>scripts</code> subdirectory, although you can modify the import code to make it work from anywhere:

	<pre>		<pre>
Line 27:		Line 27:
	import bb.tinfoil		import bb.tinfoil

			</pre>

			== Getting a variable value ==

			Let's take a look at a simple example which reads a configuration-level variable value - <code>TMPDIR</code> to be specific (I've omitted the boilerplate above):

			<pre>
	with bb.tinfoil.Tinfoil() as tinfoil:		with bb.tinfoil.Tinfoil() as tinfoil:
	tinfoil.prepare(config_only=True)		tinfoil.prepare(config_only=True)
Line 40:		Line 47:

	<pre>		<pre>
	~~#!/usr/bin/env python3~~

	~~import os~~
	~~import sys~~

	~~# Set up sys.path to let us import tinfoil~~
	~~scripts_path = os.path.dirname(os.path.realpath(__file__))~~
	~~lib_path = scripts_path + '/lib'~~
	~~sys.path.insert(0, lib_path)~~
	~~import scriptpath~~
	~~scriptpath.add_bitbake_lib_path()~~

	~~import bb.tinfoil~~

	with bb.tinfoil.Tinfoil() as tinfoil:		with bb.tinfoil.Tinfoil() as tinfoil:
	tinfoil.prepare(config_only=False)		tinfoil.prepare(config_only=False)
Line 79:		Line 72:

	<pre>		<pre>
	~~#!/usr/bin/env python3~~

	~~import os~~
	~~import sys~~

	~~# Set up sys.path to let us import tinfoil~~
	~~scripts_path = os.path.dirname(os.path.realpath(__file__))~~
	~~lib_path = scripts_path + '/lib'~~
	~~sys.path.insert(0, lib_path)~~
	~~import scriptpath~~
	~~scriptpath.add_bitbake_lib_path()~~

	~~import bb.tinfoil~~

	with bb.tinfoil.Tinfoil() as tinfoil:		with bb.tinfoil.Tinfoil() as tinfoil:
	tinfoil.prepare(config_only=False)		tinfoil.prepare(config_only=False)
Line 106:		Line 85:
	* This doesn't yet work with multiconfig - just the main configuration		* This doesn't yet work with multiconfig - just the main configuration

	There are some improvements to be made in this area which should hopefully land in 2.4.		There are some improvements to be made to the API in this area which should hopefully land in 2.4.

	== Other useful functions ==		== Other useful functions ==

	~~The~~ bitbake/lib/bb/utils.py, meta/lib/oe/utils.py, and meta/lib/oe/recipeutils.py files all contain useful functions that will help you perform various tasks that might be interesting from a script that uses tinfoil.		Tinfoil also gives you access to quite a bit of BitBake and OE utility code - in particular have a look in bitbake/lib/bb/utils.py, meta/lib/oe/utils.py, and meta/lib/oe/recipeutils.py files as they all contain useful functions that will help you perform various tasks that might be interesting from a script that uses tinfoil.

PaulEggleton at 03:05, 1 June 2017

2017-06-01T03:05:32Z

← Older revision		Revision as of 03:05, 1 June 2017
Line 6:		Line 6:
	= Writing simple utility scripts using Tinfoil =		= Writing simple utility scripts using Tinfoil =

	The tinfoil API, which was introduced to BitBake a number of years ago and underwent a major rework in the 2.3 (pyro) release, provides a way for scripts to interact with the metadata and call into BitBake/OpenEmbedded code. It's intended to be an easier-to-use wrapper around BitBake's internal code, hence the name. Some of the scripts that come with BitBake / OpenEmbedded make heavy use of it - <code>bitbake-layers</code>, <code>devtool</code>, <code>recipetool</code> and <code>oe-pkgdata-util</code> are examples.		The tinfoil API, which was introduced to BitBake a number of years ago and underwent a major rework in the 2.3 (pyro) release, provides a way for you to write python scripts to interact with the metadata and call into BitBake/OpenEmbedded code. It's intended to be an easier-to-use wrapper around BitBake's internal code, hence the name. Some of the scripts that come with BitBake / OpenEmbedded make heavy use of it - <code>bitbake-layers</code>, <code>devtool</code>, <code>recipetool</code> and <code>oe-pkgdata-util</code> are examples.

	== Getting a variable value ==		== Getting a variable value ==

PaulEggleton at 03:03, 1 June 2017

2017-06-01T03:03:04Z

← Older revision		Revision as of 03:03, 1 June 2017
Line 76:		Line 76:
	== Enumerating available recipes ==		== Enumerating available recipes ==

			Iterating over available recipes in the system is relatively straightforward:

	<pre>		<pre>
Line 104:		Line 105:
	* There's a corresponding <code>pkg_fn</code> dict that maps files to <code>PN</code> values, but bear in mind this also contains <code>virtual:...</code> entries, again created through <code>BBCLASSEXTEND</code>.		* There's a corresponding <code>pkg_fn</code> dict that maps files to <code>PN</code> values, but bear in mind this also contains <code>virtual:...</code> entries, again created through <code>BBCLASSEXTEND</code>.
	* This doesn't yet work with multiconfig - just the main configuration		* This doesn't yet work with multiconfig - just the main configuration

			There are some improvements to be made in this area which should hopefully land in 2.4.

	== Other useful functions ==		== Other useful functions ==

	The bitbake/lib/bb/utils.py, meta/lib/oe/utils.py, and meta/lib/oe/recipeutils.py files all contain useful functions that will help you perform various tasks that might be interesting from a script that uses tinfoil.		The bitbake/lib/bb/utils.py, meta/lib/oe/utils.py, and meta/lib/oe/recipeutils.py files all contain useful functions that will help you perform various tasks that might be interesting from a script that uses tinfoil.

PaulEggleton at 02:46, 1 June 2017

2017-06-01T02:46:36Z

@@ Line 6: / Line 6: @@
 = Writing simple utility scripts using Tinfoil =
-The tinfoil API, which was introduced to BitBake a number of years ago and underwent a major rework in the 2.3 (pyro) release, provides a way for scripts to interact with the metadata and call into BitBake/OpenEmbedded code. Some of the scripts that come with BitBake / OpenEmbedded make heavy use of it - <code>bitbake-layers</code>, <code>devtool</code>, <code>recipetool</code> and <code>oe-pkgdata-util</code> are examples.
+The tinfoil API, which was introduced to BitBake a number of years ago and underwent a major rework in the 2.3 (pyro) release, provides a way for scripts to interact with the metadata and call into BitBake/OpenEmbedded code. It's intended to be an easier-to-use wrapper around BitBake's internal code, hence the name. Some of the scripts that come with BitBake / OpenEmbedded make heavy use of it - <code>bitbake-layers</code>, <code>devtool</code>, <code>recipetool</code> and <code>oe-pkgdata-util</code> are examples.
 == Getting a variable value ==
@@ Line 33: / Line 33: @@
 </pre>
-If you are querying multiple variable values this is much more efficient than calling out to "bitbake -e" and parsing its output.
+If you are querying multiple variable values this is much more efficient than calling out to "bitbake -e" and parsing its output, which was the old way of getting this kind of information.
 == Parsing recipes ==
@@ Line 57: / Line 57: @@
      tinfoil.prepare(config_only=False)
      rd = tinfoil.parse_recipe('gzip')
      print('gzip SRC_URI = "%s"' % rd.getVar('SRC_URI'))
      rd = tinfoil.parse_recipe('virtual/kernel')
      print('Kernel recipe is %s' % rd.getVar('PN'))
 </pre>
-Notice that in this second example we pass <code>config_only=False</code> - this is so tinfoil will load the data for all recipes enabled in your configuration, just as bitbake does every time you run a normal build. You don't have to specify <code>config_only=False</code> to parse a recipe file if you know the path to it, but it is required if you want to specify it simply by name and get the preferred version / provider.
+Notice that in this second example we pass <code>config_only=False</code> - this tells tinfoil to load the data for all recipes enabled in your configuration, just as bitbake does every time you run a normal build. You don't have to specify <code>config_only=False</code> to parse a recipe file if you know the path to it, but it is required if you want to specify it simply by name and get the preferred version / provider.
-The <code>parse_recipe()</code> function will accept recipe names, or providers such as <code>virtual/kernel</code> in the second call above. It returns a datastore (usually seen as <code>d</code> within recipes and other python code within OE).
+The <code>parse_recipe()</code> function will accept recipe names, or providers such as <code>virtual/kernel</code> in the second call above. It returns a datastore (usually seen as <code>d</code> within recipes and other python code within OE) which you can then use to get variable values, check inheritance etc.

PaulEggleton at 01:28, 31 May 2017

2017-05-31T01:28:04Z

← Older revision		Revision as of 01:28, 31 May 2017
Line 6:		Line 6:
	= Writing simple utility scripts using Tinfoil =		= Writing simple utility scripts using Tinfoil =

	The tinfoil API, which was introduced to BitBake a number of years ago and underwent a major rework in the 2.3 (pyro) release, provides a way for scripts to interact with the metadata and call into BitBake code. Some of the scripts that come with BitBake / OpenEmbedded make heavy use of it - <code>bitbake-layers</code>, <code>devtool</code>, <code>recipetool</code> and <code>oe-pkgdata-util</code> are examples.		The tinfoil API, which was introduced to BitBake a number of years ago and underwent a major rework in the 2.3 (pyro) release, provides a way for scripts to interact with the metadata and call into BitBake/OpenEmbedded code. Some of the scripts that come with BitBake / OpenEmbedded make heavy use of it - <code>bitbake-layers</code>, <code>devtool</code>, <code>recipetool</code> and <code>oe-pkgdata-util</code> are examples.

	Let's take a look at a simple example which reads a configuration value - <code>TMPDIR</code> to be specific. This needs to be placed in the scripts ~~directory~~ to work as-is, although you can modify the import code to make it work from anywhere:		== Getting a variable value ==

			Let's take a look at a simple example which reads a configuration-level variable value - <code>TMPDIR</code> to be specific. This script needs to be placed in the <code>scripts</code> subdirectory to work as-is, although you can modify the import code to make it work from anywhere:

	<pre>		<pre>
Line 30:		Line 32:
	print('TMPDIR is "%s"' % tmpdir)		print('TMPDIR is "%s"' % tmpdir)
	</pre>		</pre>


	If you are querying multiple variable values this is much more efficient than calling out to "bitbake -e" and parsing its output.		If you are querying multiple variable values this is much more efficient than calling out to "bitbake -e" and parsing its output.

			== Parsing recipes ==

	Here's another example where we parse a couple of recipes:		Here's another example where we parse a couple of recipes:

PaulEggleton: Created page with " {| style="color:black; background-color:#ffffcc" width="100%" cellpadding="10" class="wikitable" | '''NOTE:''' This is currently a draft, needs additional content & editing -..."

2017-05-31T01:22:35Z

Created page with " {| style="color:black; background-color:#ffffcc" width="100%" cellpadding="10" class="wikitable" | '''NOTE:''' This is currently a draft, needs additional content & editing -..."

New page

{| style="color:black; background-color:#ffffcc" width="100%" cellpadding="10" class="wikitable"
| '''NOTE:''' This is currently a draft, needs additional content & editing - [[User:PaulEggleton|PaulEggleton]] ([[User talk:PaulEggleton|talk]]) 18:22, 30 May 2017 (PDT)
|}

= Writing simple utility scripts using Tinfoil =

The tinfoil API, which was introduced to BitBake a number of years ago and underwent a major rework in the 2.3 (pyro) release, provides a way for scripts to interact with the metadata and call into BitBake code. Some of the scripts that come with BitBake / OpenEmbedded make heavy use of it - <code>bitbake-layers</code>, <code>devtool</code>, <code>recipetool</code> and <code>oe-pkgdata-util</code> are examples.

Let's take a look at a simple example which reads a configuration value - <code>TMPDIR</code> to be specific. This needs to be placed in the scripts directory to work as-is, although you can modify the import code to make it work from anywhere:

<pre>
#!/usr/bin/env python3

import os
import sys

# Set up sys.path to let us import tinfoil
scripts_path = os.path.dirname(os.path.realpath(__file__))
lib_path = scripts_path + '/lib'
sys.path.insert(0, lib_path)
import scriptpath
scriptpath.add_bitbake_lib_path()

import bb.tinfoil

with bb.tinfoil.Tinfoil() as tinfoil:
tinfoil.prepare(config_only=True)
tmpdir = tinfoil.config_data.getVar('TMPDIR')
print('TMPDIR is "%s"' % tmpdir)
</pre>

If you are querying multiple variable values this is much more efficient than calling out to "bitbake -e" and parsing its output.

Here's another example where we parse a couple of recipes:

<pre>
#!/usr/bin/env python3

import os
import sys

# Set up sys.path to let us import tinfoil
scripts_path = os.path.dirname(os.path.realpath(__file__))
lib_path = scripts_path + '/lib'
sys.path.insert(0, lib_path)
import scriptpath
scriptpath.add_bitbake_lib_path()

import bb.tinfoil

with bb.tinfoil.Tinfoil() as tinfoil:
tinfoil.prepare(config_only=False)

rd = tinfoil.parse_recipe('gzip')
print('gzip SRC_URI = "%s"' % rd.getVar('SRC_URI'))

rd = tinfoil.parse_recipe('virtual/kernel')
print('Kernel recipe is %s' % rd.getVar('PN'))
</pre>

Notice that in this second example we pass <code>config_only=False</code> - this is so tinfoil will load the data for all recipes enabled in your configuration, just as bitbake does every time you run a normal build. You don't have to specify <code>config_only=False</code> to parse a recipe file if you know the path to it, but it is required if you want to specify it simply by name and get the preferred version / provider.

The <code>parse_recipe()</code> function will accept recipe names, or providers such as <code>virtual/kernel</code> in the second call above. It returns a datastore (usually seen as <code>d</code> within recipes and other python code within OE).