Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle abstract properties #2333

Merged
merged 3 commits into from
Nov 18, 2024
Merged

Handle abstract properties #2333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
529aa6e
Handle abstract properties and attributes
Eric-Arellano Nov 15, 2024
5ef1826
Regenerate qiskit 0.19.6
Eric-Arellano Nov 15, 2024
b170c51
Fix fmt
Eric-Arellano Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver

### aux\_operators

<Attribute id="qiskit.aqua.algorithms.MinimumEigensolver.aux_operators" attributeTypeHint="Optional[List[Optional[qiskit.aqua.operators.operator_base.OperatorBase]]]">
<Attribute id="qiskit.aqua.algorithms.MinimumEigensolver.aux_operators" attributeTypeHint="Optional[List[Optional[qiskit.aqua.operators.operator_base.OperatorBase]]]" modifiers="abstract property">
Returns the auxiliary operators.

**Return type**
Expand All @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver

### operator

<Attribute id="qiskit.aqua.algorithms.MinimumEigensolver.operator" attributeTypeHint="Optional[Union[qiskit.aqua.operators.operator_base.OperatorBase, qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator]]">
<Attribute id="qiskit.aqua.algorithms.MinimumEigensolver.operator" attributeTypeHint="Optional[Union[qiskit.aqua.operators.operator_base.OperatorBase, qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator]]" modifiers="abstract property">
Return the operator.

**Return type**
Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit/0.19/qiskit.aqua.components.oracles.Oracle.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle

### ancillary\_register

<Attribute id="qiskit.aqua.components.oracles.Oracle.ancillary_register">
<Attribute id="qiskit.aqua.components.oracles.Oracle.ancillary_register" modifiers="abstract property">
returns ancillary register
</Attribute>

Expand All @@ -38,15 +38,15 @@ python_api_name: qiskit.aqua.components.oracles.Oracle

### output\_register

<Attribute id="qiskit.aqua.components.oracles.Oracle.output_register">
<Attribute id="qiskit.aqua.components.oracles.Oracle.output_register" modifiers="abstract property">
returns output register
</Attribute>

<span id="oracle-variable-register" />

### variable\_register

<Attribute id="qiskit.aqua.components.oracles.Oracle.variable_register">
<Attribute id="qiskit.aqua.components.oracles.Oracle.variable_register" modifiers="abstract property">
returns variable register
</Attribute>

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase

### num\_qubits

<Attribute id="qiskit.aqua.operators.OperatorBase.num_qubits" attributeTypeHint="int">
<Attribute id="qiskit.aqua.operators.OperatorBase.num_qubits" attributeTypeHint="int" modifiers="abstract property">
The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not.

**Return type**
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator

### num\_qubits

<Attribute id="qiskit.aqua.operators.legacy.LegacyBaseOperator.num_qubits">
<Attribute id="qiskit.aqua.operators.legacy.LegacyBaseOperator.num_qubits" modifiers="abstract property">
Returns number of qubits for operator
</Attribute>

Expand Down
29 changes: 22 additions & 7 deletions scripts/js/lib/api/generateApiComponents.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,16 +116,9 @@ function prepareProps(

const githubSourceLink = prepareGitHubLink($child, apiType === "method");

// Remove the attributes and properties modifiers as we don't show their signatures,
// but we still use them to create their headers
if (apiType == "attribute" || apiType == "property") {
findByText($, $child, "em.property", apiType).remove();
}

if (!(apiType in preparePropsPerApiType)) {
throw new Error(`Unhandled Python type: ${apiType}`);
}

return preparePropsPerApiType[apiType]();
}

Expand Down Expand Up @@ -207,6 +200,27 @@ function prepareAttributeOrPropertyProps(
githubSourceLink: string | undefined,
id: string,
): ComponentProps {
// Properties/attributes have multiple `em.property` values to set:
//
// - the modifiers, like `property` or `abstract property`
// - the type hint
// - the default value
//
// We need to remove the modifiers `em.property` to not mess up creating the heading, although
// we must first extract any modifiers. Attributes will not have modifiers, whereas
// properties will have `property` or possibly `abstract property`. If the modifier is simply
// `property`, then we do not save its value because there is no practical difference for end-users
// between an attribute and property. However, we preserve the full string if it's `abstract property`.
//
// Meanwhile, we preserve the non-modifier `em.property` elements to be processed below.
const rawModifiers = $child
.find("em.property")
.filter((i, el) => $(el).text().includes("property"));
const modifiersText = rawModifiers.text().trim();
const filteredModifiers =
modifiersText === "property" ? undefined : modifiersText;
rawModifiers.remove();

const text = $child.text();

// Index of the default value of the attribute
Expand Down Expand Up @@ -235,6 +249,7 @@ function prepareAttributeOrPropertyProps(
attributeTypeHint,
attributeValue,
githubSourceLink,
modifiers: filteredModifiers,
};

if (!priorApiType && id) {
Expand Down
49 changes: 49 additions & 0 deletions scripts/js/lib/api/htmlToMd.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,6 +748,55 @@ test("convert class property headings", async () => {
});
});

test("convert abstract class property headings", async () => {
expect(
await toMd(
`<div role='main'>
<h1>Estimator.circuits<a class='headerlink' href='#estimator' title='Permalink to this heading'>¶</a></h1>
<dl class='py property'>
<dt class='sig sig-object py' id='qiskit_ibm_runtime.Estimator.circuits'>
<em class='property'
><span class='pre'>abstract</span><span class='w'> </span><span class='pre'>property</span><span class='w'> </span></em
><span class='sig-prename descclassname'
><span class='pre'>Estimator.</span></span
><span class='sig-name descname'><span class='pre'>circuits</span></span
><em class='property'
><span class='p'><span class='pre'>:</span></span
><span class='w'> </span><span class='pre'>tuple</span
><span class='p'><span class='pre'>[</span></span
><span class='pre'>qiskit.circuit.quantumcircuit.QuantumCircuit</span
><span class='p'><span class='pre'>,</span></span
><span class='w'> </span
><span class='p'><span class='pre'>...</span></span
><span class='p'><span class='pre'>]</span></span></em
><a
class='headerlink'
href='#qiskit_ibm_runtime.Estimator.circuits'
title='Permalink to this definition'
>¶</a
>
</dt>
<dd><p>Quantum circuits that represents quantum states.</p></dd>
</dl>
</div>
`,
true,
),
).toEqual({
images: [],
isReleaseNotes: false,
markdown: `# circuits

<Attribute id="qiskit_ibm_runtime.Estimator.circuits" attributeTypeHint="tuple[qiskit.circuit.quantumcircuit.QuantumCircuit, ...]" isDedicatedPage={true} modifiers="abstract property">
Quantum circuits that represents quantum states.
</Attribute>\n`,
meta: {
apiName: "qiskit_ibm_runtime.Estimator.circuits",
apiType: "property",
},
});
});

test("convert class method headings", async () => {
expect(
await toMd(
Expand Down
2 changes: 1 addition & 1 deletion scripts/js/lib/api/processHtml.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ marked as builtins since they are not actually present in any include file this
const meta: Metadata = { apiType: "module", apiName: "my_module" };
await processMembersAndSetMeta(doc.$, doc.$main, meta);
doc.expectHtml(`
<h3 data-header-type="attribute-header">qiskit.qasm2.LEGACY_CUSTOM_INSTRUCTIONS¶</h3><div><attribute id="qiskit.qasm2.LEGACY_CUSTOM_INSTRUCTIONS" attributetypehint="" attributevalue="" isdedicatedpage="undefined" github="undefined" signature="" modifiers="undefined" extrasignatures="[]">
<h3 data-header-type="attribute-header">qiskit.qasm2.LEGACY_CUSTOM_INSTRUCTIONS¶</h3><div><attribute id="qiskit.qasm2.LEGACY_CUSTOM_INSTRUCTIONS" attributetypehint="" attributevalue="" isdedicatedpage="undefined" github="undefined" signature="" modifiers="" extrasignatures="[]">

<div><p>A tuple containing the extra <cite>custom_instructions</cite> that Qiskit’s legacy built-in converters used
if <code class="docutils literal notranslate"><span class="pre">qelib1.inc</span></code> is included, and there is any definition of a <code class="docutils literal notranslate"><span class="pre">delay</span></code> instruction. The gates
Expand Down